API Provider Method

In this article, we will look at creating and configuring the API Provider Method. You can find how to set up API Provider in this article.

What is API Provider Method

Each method is an action (with a set of required and additional parameters, and each of them will be determined when creating an Operation), which will be performed when sending an API request to a third-party service.

Creating New API Provider Method

  • Navigate to API Providers section on the Home Screen of the 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 - enter name of the new API method
    • Method - select one of the available HTTP request methods (GET, POST, PUT, DELETE)
    • Endpoint URL - specify the endpoint URL that will be used for the API request
    • 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.

If you need to change or delete the parameter, then click the Quick Access Menu (three vertical dots) on the left of the API Method and select the action you want to perform.

Если необходимо изменить или удалить параметр, то нажмите на кнопку Быстрого меню (три вертикально расположенные точки) слева от нужного Вам параметра и выберите пункт Edit или Delete.

  • Click Save API Provider Method
  • Click Close to return to API Provider settings.

API Provider Method is now saved and available in API Provider settings.

Changing API Provider Method

To change the API Provider Method please perform the following steps:

  • In the API Providers section, click the API Provider, that you want to change
  • In the pop up opened go to the API Provider Methods tab
  • Click on the Name fo the API method that you want to change or click the Quick Access Menu (three vertical dots) on the left of the API Method and select Edit
  • In the window opened make all the required changes
  • Click Save API Provider Method
  • Click Close

API Method settings are updated now.

Deleting API Provider Method

To delete the API Provider Method please perform the following steps:

  • In the API Providers section, click the API Provider, that you want to delete
  • In the pop up opened go to the API Provider Methods tab
  • Click on the Name fo the API method that you want to change or click the Quick Access Menu (three vertical dots) on the left of the API Method and select Delete

The API Provider Method is deleted now


How did we do?