Authentication and rate-limits

Authentication tokens are used to enable access to the API without rate-limits or data limits. This takes a format like ubxbhwera9xkmx4yoej6yt5tslvpjcdj. Each client uses one or more tokens to connect to the APIs, as each is associated with a set of permissions.

{
    "message": "You have been ratelimited; please sign up for a key at https://reincubate.com/deviceidentifier-api/ if you require a larger limit",
    "retry_after": 3405,
    "type": "permission_denied_rate"
}

We ask that users consuming the API in anonymous mode provide a link in their product back to the DeviceIdentifier API's product page.

Obtaining a token

Authentication is performed using a token provided by Reincubate, which can be obtained here.

Authenticating with a token

If one had a token of ubxbhwera9xkmx4yoej6yt5tslvpjcdj, it could be used by setting the HTTP Authorization header to Token ubxbhwera9xkmx4yoej6yt5tslvpjcdj. Like so:

$ wget https://di-api.reincubate.com/v1/gsma-imeis/352073069165968/ --header="Authorization: Token ubxbhwera9xkmx4yoej6yt5tslvpjcdj" -qSO - --content-on-error

The client libraries include their own documentation, and support the token being set via an environment variable, like so:

$ export RI_DEVID_TOKEN='ubxbhwera9xkmx4yoej6yt5tslvpjcdj'

Usage credits

Access to the API can be obtained via usage credits. A credit is used per unique query, which means repeated requests for the same information will only use a single credit.

If you are using a token with usage credits associated to it, responses from the API will contain the header Di-Credits-Remaining with the count of unused credits.

If your token runs out of credits, you can still repeat previously made queries but requests with new queries will return a HTTP 403 response.

{
    "type": "no_credits_remaining",
    "message": "There are no credits remaining on this token. Please contact enterprise@reincubate.com for additional credits.",
}