In some cases, customers may also need access to their Servitly account data, for example, to integrate connected products with business processes.
To do this, you will need to configure for your client, an API Key that will be used to make calls to the various APIs provided by Servitly.
API Key configuration
For each customer, by entering the editing page, you can access the API Key tab, and by clicking the Generate API Key button, you can generate a new unique API Key.
Within the API Key configuration panel, you can define the maximum number of requests the customer can perform per hour or month using the generated API Key. The Permissions tab can be used to limit the API endpoints the customer can invoke.
If the API key is deleted, the client can no longer use it and a new one must be generated.
Customer API Key
Customer administrators, by entering the Account page, under the top right user menu, can have a view of the status of the API Key (if configured).
For more information on how to invoke the REST API, refer to article How to deal with REST APIs.
Requests Rate Limits
By default, customer-level API Keys are created with a quota of 100 requests/hour and 10.000 requests/month.
Compared to global API keys, when the rate limit is exceeded, the client is no longer able to make API requests until the next hour or, in the worst case, until the next month. So be careful to set the right requests rate to avoid ending the quota early.
Comments
0 comments
Please sign in to leave a comment.