Every API you build in API builder requires an API token when you invoke it from outside integrator.io, such as from Postman or cURL. Copy the invoke URL or a ready-made cURL command from integrator.io, send the token in the Authorization header, and stay within the request size and rate limits.
Authenticate with an API token
All APIs include token authentication, so you never add authentication to custom headers. Create a custom API token that applies only to specific APIs, or a token with full access to your account. See Create and manage API and Personal Access tokens.
To use JWT, OAuth 2.0, or another authentication method, see The API Management console - Features and concepts. You must update the OpenAPI schema in the API Management console manually.
An API's endpoint URL is publicly accessible and can match an endpoint in another account, but only callers with a valid API token can invoke it. Two APIs that are turned on in your account can't have the same endpoint URL.
Copy the invoke URL
The invoke URL has the form https://api.integrator.io/apis/<version>/<relative URI>.
To copy the invoke URL:
- Open your API in API builder.
- Select Actions
> Copy Invoke URL.
Copy the cURL command
Copy cURL is available only after you Configure an API request using API builder.
To copy the cURL command:
- Go to Build
, and then select APIs, and then select API builder.
- Find your API in the list, and then select Actions
> Copy cURL.
- Replace the masked token with your API token.
- Run the command.
The command looks like this one:
curl -X GET "https://api.integrator.io/apis/v1/chocolates/sampleid?sku=true" \ -H "Authorization: Bearer ****"
For the responses callers receive when a request fails, see Error handling in API builder.
Request size
Request content can't exceed 5 MB. If your API is likely to return large result sets, turn on pagination to keep individual responses within this limit. See Configure advanced API settings.
Concurrency and rate limits
The concurrency level you set on a connection doesn't apply to API requests, so you can invoke the same API in parallel. Your APIs share a global rate limit: they can burst up to 1,000 requests, and then refill at 300 requests per second, which allows approximately 1,080,000 requests per hour.
The application you connect to can have its own rate limits. For example, if you set a connection's concurrency level to 5, integrator.io ignores that level for API requests, but the application might allow a maximum concurrency of 15. Requests that exceed the application's limit can return an error.
To change how long an API waits for a request to finish, see Configure advanced API settings.