Rate Limiting
Was this helpful?
Was this helpful?
Rate limiting in digiRunner controls the number of API requests allowed within a specific time frame, ensuring system stability and preventing abuse. The rate limiting configuration can be applied to individual clients or groups based on their API access levels.
In digiRunner, rate limiting is implemented through adjustments to the API Quota and TPS/Node settings.
Go to Client Management > API Client to manage clients subject to rate limits. You can either create a new client or update an existing one.
Click Create to access the client creation page.
For more information about client creation, please refer to API Client.
When creating or updating an API client, configure the API Quota and TPS/Node (Transactions per second) settings.
API Quota: Specifies the total number of API calls the client can make without restriction. If the same API was pressed repeatedly 10 times, it also counts as 10 times.
If set to 0, it means there are no limits.
TPS/Node (Default 10): Specifies the number of times this client can call the API per second. The default for this field is 10, meaning that the API will be called 10 times per second. For example, if both the TPS/Node and API Quota are set to 10, the user can make 10 API calls per second. However, once the user reaches a total of 10 calls for the day, further API access will be denied.
If set to 0, it means there are no limits.
Go to Client Management > API Group.
Create a new group for clients to which you want to apply rate limiting.
Add the desired API to this group, which will apply the rate limiting rules.
Assign the clients to the group so that they inherit the rate limiting settings for this API.
For more information, please refer to API Group.
Go to API Management > API Test to test the API with the rate-limited group.
Send requests to the API via the API Test feature to verify that rate limiting is enforced.
For more information, please refer to API Test.
Observe API responses; if the rate limit is exceeded, the server will return an HTTP 429 (Too Many Requests) error.
Search for the client to modify, and click on the icon to access the update page.
