Method is an action, which is performed when API Request is sent to the server. To create one do the following steps:
Navigate to Providers section on the Side Menu of Mobsted platformÂ
Select the API provider, for which you want to create API method
In the pop up opened go to the API Provider Methods tab
Click Create new API Provider Method
Fill in the following fields:
- Api Provider Method Name
- Method - select one of the available HTTP request methods (GET, POST, PUT, DELETE)
- Endpoint URL
- Consumes Type - select the data type used when sending the API request
- Produces Type - elect the response type to the request sent by the API
- Parameters - create the required and optional parameters for your API method
Most API queries must contain a number of parameters.
To create a parameter, click the Add Parameter button.
In the pop up opened fill in the following fields:
- Name - Parameter name according to the documentation of the third-party service provider
- In - select in which part of the API request this parameter should be used (query, header, path, formData, body)
- Type - select parameter data type (string, number, integer, boolean)
- Description - add the parameter description so that your colleagues can understand what data you need to specify
- Required - check the checkbox if you want the parameter to be mandatory
Click Save Parameter. If the API method should contain several parameters, then repeat the above steps.
Click Save API Provider Method
Click Close to return to API Provider settings.