Authentication
Authenticate
Before making any requests to protected resources, you must authenticate using an email address and password to obtain an access token. Credentials to access API resources differ from user credentials for portal access. Excessive failed attempts will result in throttling.
Properties
Property | More |
|---|---|
Required. The email address of the account with access to API resources | |
password | Required. The associated password. |
Example Request
{
"email": "[email protected]",
"password": "myverylongpassword"
}
Example Response
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...."
}
Token Validity
Token validity is customisable for high risk applications, but has a default-soft long-lived setting of 1440 minutes. At which point API requests will return 401 Unauthorized.
The tokens expiry timestamp is encoded within the token if maintaining validity periods within your application is desired. We highly recommend having an authentication workflow to request a new token if your current token becomes invalid - and not simply rely on a manually obtained token and its lifetime. Jomablue reserves the right to revoke your token between feature releases if required - the authentication endpoints will be immediately available so that you can obtain a new token.
Rate Limits
This API is heavily rate limited to one request per hour due to the function of this being a method of obtaining data post-event for archiving and the requests triggers a report generation process.