Any API built-in Integrator requires authentication, using either a JWT token, received from the authentication API, or a username and password.
User-defined API endpoint
The endpoint URL is defined as https://etlworks_base_url/rest/v1/httplistener/url_pattren.
Read about the URL pattern set for the listener.
To configure an API endpoint with JWT authentication, select
JWT when defining the Auth Type parameter for the HTTP listener. Select either
Header (recommended and more secure) or
Query Parameter (less secure) for the Auth Location.
Learn about the Authentication API.
Calling Integrator's REST API endpoints, when using JWT authentication
Step 1. Create an API user.
You can actually use any user, as long as they have a required role (see below). API user can only be used to executed API endpoints, created in Integrator using listeners.
Step 2. Use the user to call an Integrator authentication endpoint and receive an access token.
Optionally, you can generate the not-expirable API key and use it as access-token in step 3. In this case, you can skip step 2 altogether.
Step 3. Use the access token, received in Step 2, to call Integrator API endpoints. The access token must be submitted as a header parameter, as in:
Authorization:Bearer access-token, or query parameter, as in:
Access tokens in Integrator are short-lived and self-expiring. An access token gives you access to the APIs for approximately 10 minutes. It is recommended that you refresh the access token before each call to the API. Alternatively, you can use the not-expiable API key as an access token.
Generally speaking, basic authentication is less secure than JWT. Use it only if it is impossible to use a two-step authentication. For example, this would be used when a third-party application has a simple web hook that sends a payload to the API.
To configure an API endpoint with
Basic authentication, select
Basic when defining the Auth Type parameter for the HTTP listener. Select either
Header (recommended and more secure), or
Query Parameter(less secure) for the Auth Location.
Calling Integrator's REST API endpoints when using basic authentication
Only APIs created in Integrator using listener can be configured to be authenticated with the basic auth. All internal Integrator's APIs require JWT authentication.
Step 1. Create an API user.
you can actually use any user, as long as they have a role that can execute flows.
Step 2. Use the username and password for the user created in Step 1, to call an API endpoint.
Read more about basic authentication.
Calling user-defined API from Etlworks Integrator
Typically, the third-party application will be calling a user-defined API.
To execute a flow without leaving Integrator, you will need to create another flow as a sender, as explained in this article.
Read how to call user-defined PULL API endpoint from the Explorer.