What you need for getting started with API Gateway
Where supported, the
Accept-Languageheader will influence the translations used for results. The
enflag is the the default one used if no flag is specified.
The following languages will be returned by default, unless otherwise requested:
en- English (default)
When the translations parameter is used, the content will be returned in all 5 languages by default.
The complete list of available languages:
The Extra Language pack is available on request.
- 1.You will be provided with a
- 2.Using that information a token can be generated by doing a request to
POST /oauth/tokenusing the credentials
- 3.The response will contain a
tokenand the number of seconds until expiration
- 4.Until the token expires, all authenticated requests must contain the header
Authorization: Bearer <TOKEN>
This section includes the generic, optional header parameters you can use in your API calls.
Generic header parameters (optional)
The Boost.rs API only allows a set number of requests during a small unit of time. These values are prone to change, but the necessary information will be available in every response through the following headers:
Once authenticated, responses will always have
Content-type: application/jsonand will have the following format:
"success": true, // or false if there was an error
"message": "", // will contain error messages
"result": null // will contain api results
Going over the rate limit will result in a
429 Too Many RequestsHTTP error with the following response:
"message": "Too Many Attempts.",