This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata

Access to the Open Data API is subject to rate limiting: if you submit too many requests within a short period of time, you will be unable to submit further requests to the API until your limit resets. This is to ensure that the API performs well for all users and that it is not possible for a single application to overload the server.

By default, the Open Data API is configured to allow any given API key to submit up to 100 requests per hour, but the administrator of the system may have configured a different limit.

Caching

You are recommended to implement a local caching mechanism to reduce the number of requests you need to make to the server.

With the exception of the /table endpoint, all responses from the Open Data API return an ETag header. To check whether a resource has changed, your application can include this with subsequent requests in the If-None-Match header. If the resource has not changed, then the Open Data API will return a HTTP 304 Not Modified response. 304 responses do not count towards your rate limit.

Check Your Rate Limit

The /rate_limit endpoint returns information about your current rate limit. In addition, all requests return the 3 X-RateLimit headers, allowing you to check your rate limit at any time without having to submit a specific request.

Submitting a request to the /rate_limit endpoint does not count towards your rate limit.

Overview

Endpoint
http://<server>/webapi/rest/v1/rate_limit
HTTP MethodGET

Request Headers

Accept-Language
The language that labels will be returned in (setting this is equivalent to changing the dataset and user interface language in SuperWEB2).Optional. If not set, the server default language will be used.
APIKey
The API Key to use to authenticate this request. You can obtain your API key from the Preferences page in SuperWEB2.Required in all requests.

Response Headers

X-RateLimit
The rate limit configured for this server. By default, this is set to 100.
X-RateLimit-Remaining
The number of requests remaining for the current rate limiting period. If this value drops to 0 then you will not be able to submit any further requests using this API key until the limit resets.
X-RateLimit-Reset
The time when the rate limit will next be reset. This is expressed as a UNIX timestamp in milliseconds (the number of milliseconds since January 1st 1970).

Response Body

Following is an example response. In this example the API key has 100 requests remaining (from a configured rate limit of 100). This allocation will be reset at UNIX timestamp 1451001600000 (25/12/2015 at midnight UTC).

{
  "limit": 100,
  "remaining": 100,
  "reset": 1451001600000
}
  • No labels