This API accepts request bodies in JSON format and requires the content to include the
Content-Type: application/json header. This header must be specified in every request.Domain
The Jelou API is available at the following domain:Authentication
Clients using this API will receive aclient ID and a client secret key for basic authentication.
For any API endpoint, the following header must be added:
Example
If yourclientId is my_client_id and your clientSecret is my_client_secret:
- Join them with a colon:
my_client_id:my_client_secret - Encode it in Base64:
bWlfY2xpZW50X2lkOm1pX2NsaWVudF9zZWNyZXQ= - Include it in the header:
Authorization: Basic bWlfY2xpZW50X2lkOm1pX2NsaWVudF9zZWNyZXQ=
Errors
Jelou uses HTTP standards to report errors. In general:- 2XX codes indicate success.
- 4XX codes indicate client errors.
- 5XX codes indicate server errors.
code and a detailed description of the problem.
Error codes
| Code | HTTP Status Code | Description |
|---|---|---|
bot_not_found | 404 | The company does not have permission to use this bot. |
forbidden_bot | 403 | You do not have permission to use this bot. |
message_could_not_be_send | 400 | The message could not be sent due to a bad request. |
notification_could_not_be_send | 400 | The notification could not be sent due to a bad request. |
unauthorized | 401 | You are not authorized to perform this request. |
unprocessable_entity | 422 | A field is missing or there is an error in the request. |
internal_server_error | 500 | The authorization token does not have an assigned company. |