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.
refresh_token	String	Token à utiliser pour renouveler le token sans se réauthentifier (voir Rafraîchir un token).
refresh_until	Timestamp	Date et heure de fin de validité du refresh_token.
update_password	Bool	true si le mot de passe du compte doit être changé.

Rafraîchir un token

Permet d'obtenir un nouveau token sans se réauthentifier avec appId/appKey, en utilisant le refresh_token obtenu lors du login.

POST /v1/refreshToken
Content-type: application/json

{
  "appId": "votre-app-id",
  "appKey": "votre-app-key",
  "refreshToken": "votre-refresh-token"
}

Paramètres

Champ	Type	Description
appId	String	Id d'application, fourni par Carmoove.
appKey	String	Clé d'authentification, fournie par Carmoove.
refreshToken	String	Refresh token obtenu lors du login.

Réponse

Champ	Type	Description
token	String	Nouveau token d'authentification.
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 :

GET /v1/vehicles
x-carmoove-token: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ2LXVSeWFuNUFCaE9NSXFaU0tjWG1STURrRHFx...
Content-type: application/json