Authentification¶
L'accès à l'API est sécurisé. Il est nécessaire de commencer par s'authentifier afin d'obtenir un token, qui sera obligatoire pour toute utilisation de l'API.
Le token fourni par l'API doit être transmis dans l'en-tête de chaque requête, dans le champ x-carmoove-token. Il est également nécessaire de transmettre le champ Content-type dans l'en-tête.
Obtenir un token¶
POST /v1/login
Content-type: application/json
{
"appId": "votre-app-id",
"appKey": "votre-app-key"
}
Paramètres¶
| Champ | Type | Description |
|---|---|---|
appId |
String | Id d'application, fourni par Carmoove. |
appKey |
String | Clé d'authentification, fournie par Carmoove. |
Réponse¶
| Champ | Type | Description |
|---|---|---|
token |
String | Token d'authentification, à fournir dans le header x-carmoove-token. |
until |
Timestamp | Date et heure de fin de validité du token. |
Utiliser le token¶
Toute requête vers un autre endpoint de l'API doit inclure le token obtenu, ainsi que le type de contenu :