Setup a connector with a rate limit
In this tutorial, we will guide you through setting up a connector on your Cargo workspace and adding an API rate limit.
Before you begin
Ensure you have an API key (or equivalent) for a 3rd-party tool integrated with Cargo. As well as, familiarized yourself with the documentation and the different rate limits applicable to the service.
Setting rate limits on a connector is an enterprise feature, contact us to set this up on your workspace.
Add and set up the connector
Choose a node from the node catalog and drag it onto the workflow. For this example, we will use Apollo.
If the connector hasn't been set up yet on your workspace, you will see a setup connector
indicating this on the top of the right-hand panel.
Clicking the button will open a settings modal to configure the connector with the necessary details:
- Name: Add any unique name for this connector
- Configure the authentication: Depending on the node, you may need to add an API key or equivalent credentials to authenticate your connection to this tool.
Calculate the optimal rate limit
Note the different rate limits from the documentation of the chosen tool.
For example, an advanced plan with Apollo imposes the following limits:
"Max per day": 6000, "Max per hour": 400, "Max per minute": 200
- Identify any maximum thresholds: For instance, if you plan to attempt only a maximum of 2000 calls, then you can disregard the daily limit.
- Calculate the optimal rate: Given the hourly allowance of 400 calls and the ability to disregard the daily limit, setting the rate to approximately 6 calls per minute ensures compliance with both the hourly and minutely limits, maintaining a safe margin below the maximum allowed rates.
Untoggling the advanced settings
will reveal a rate limits parameter.
Input the rate limit and choose the right unit of time. Press save/create to apply the new settings.
Finish line
By following these steps, you have successfully set up a connector and configured an API rate limit. This ensures efficient usage of the API within the allowable limits, preventing overuse and potential service disruptions.