Getting started
What you need for getting started with API Gateway
Prerequisites
To use API Gateway and other Boostrs services, you need a Boostrs business account. If you don't have an account, reach out to us via the customer support email support@boost.rs.
Languages
Where supported, the Accept-Language
header will influence the translations used for results. The en
flag is the the default one used if no flag is specified.
The language codes are defined according to ISO 639-1 list.
The following languages will be returned by default, unless otherwise requested:
en
- English (default)fr
- Frenchde
- Germanes
- Spanishit
- Italian
When the translations parameter is used, the content will be returned in all 5 languages by default.
With the translation_language
parameter you can get maximum 5 translations, per the requested language codes.
The complete list of available languages:
ISO Language | ISO 639-1 code | Availability |
---|---|---|
English | en | Default |
French | fr | Default |
German | de | Default |
Italian | it | Default |
Spanish | es | Default |
Arabic | ar | Extra Language pack* |
Bulgarian | bg | Extra Language pack* |
Croatian | hr | Extra Language pack* |
Czech | cs | Extra Language pack* |
Danish | da | Extra Language pack* |
Dutch | nl | Extra Language pack* |
Estonian | et | Extra Language pack* |
Finnish | fi | Extra Language pack* |
Greek | el | Extra Language pack* |
Hungarian | hu | Extra Language pack* |
Icelandic | is | Extra Language pack* |
Irish | ga | Extra Language pack* |
Latvian | lv | Extra Language pack* |
Lithuanian | lt | Extra Language pack* |
Maltese | mt | Extra Language pack* |
Norwegian | no | Extra Language pack* |
Polish | pl | Extra Language pack* |
Portuguese | pt | Extra Language pack* |
Romanian | ro | Extra Language pack* |
Slovak | sk | Extra Language pack* |
Slovenian | sl | Extra Language pack* |
Swedish | sv | Extra Language pack* |
The Extra Language pack is available on request.
If you have any questions regarding the translations, you need to upgrade your account or need any help, reach out by sending us an email at support@boost.rs.
Authentication
The Boostrs API uses OAuth 2.0 Client Grant in order to authenticate clients.
You will be provided with a
CLIENT_ID
andCLIENT_SECRET
Using that information a token can be generated by doing a request to
POST /oauth/token
using the credentialsThe response will contain a
token
and the number of seconds until expirationUntil the token expires, all authenticated requests must contain the header
Authorization: Bearer <TOKEN>
Request Header - parameters
This section includes the generic, optional header parameters you can use in your API calls.
Generic header parameters (optional)
GET
Headers
Name | Type | Description |
---|---|---|
Accept | String |
|
Accept-Language | String | Allows you to specify if you want the output to be in one of the accepted languages. Format: ISO 639-1 language code. If no value is specified, the response language will be English. |
Response Header - limits
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:
Header Key | Description |
---|---|
| The total quota (monthly number of API calls). |
| Remaining (available) number of API calls from your total quota. |
| The maximum number of requests in the time window |
| The number of seconds to wait before trying again to avoid the error |
| The number of seconds to wait before trying again to avoid the error |
| The UNIX timestamp when the limit will be lifted. It will be equal to the value of the current timestamp + |
Response Body - format
Once authenticated, responses will always have Content-type: application/json
and will have the following format:
Going over the rate limit will result in a 429 Too Many Requests
HTTP error with the following response:
Last updated