Skip to main content

Authentification (DEPRECATED)

info

deprecated note: Cette méthode d'authentification étant plus contraignante pour vous, elle n'est plus celle que l'on recommande, elle est seulement disponible pour nos clients historiques et nous vous recommandons d'utiliser la méthode d'authentification décrite ici.

Tous les appels à l'API publique doivent se faire de manière authentifiée. Voici les étapes pour pouvoir faire votre premier appel à l'API.

Un administrateur Cocolis doit vous créer une "API application", qui vous sera associée. Un identifiant app_id et une clé vous seront transmis.

Obtenir ses tokens d'authentification​

Faites un premier appel à l'API pour vous authentifier via :

info

Remplacez bien le body de la requête avec votre app_id et votre password

{
  "method": "post",
  "url": "https://api.cocolis.fr/api/v1/app_auth/sign_in",
  "body": {
    "app_id": "your_app_id",
    "password": "your_password"
  }
}

Vous recevrez dans le header de la réponse les 4 infos suivantes:

access-token: v763753qcQGBjTn2HcnfUQ
client: R3z_2Ed82uUvApIy4hqtxQ
expiry: 1586424091
uid: 07b8c9c1

Ces infos spécifiques à votre session vous permettront de rester authentifié lors de vos prochains appels. La session expire à la date fournie par le header expiry.

warning

Vous devez les sauvegarder dans votre base de donnée, cache... ou vous voulez pour les réutiliser.

Appels authentifiés​

Lors de tous vos appels suivants, vous devez fournir ces 4 informations en header de vos appels pour vous authentifier:

info

Remplacez bien les headers de la requête avec les informations retournées par la requête précédente

{
  "method": "get",
  "url": "https://api.cocolis.fr/api/v1/rides/mine",
  headers: {
    Content-Type: application/json,
    token-type: Bearer,
    uid: uid_of_previous_request,
    access-token: access_token_of_previous_request,
    client: client_of_previous_request,
    expiry: expiry_of_previous_request
  }
}

Vérification de la validité de vos tokens​

A chaque début de communication avec l'API, vous devez vérifier si vos tokens sauvegardés et précédemment générés sont toujours valides. Pour cela, vous devez faire l'appel :

{
  "method": "get",
  "url": "https://api.cocolis.fr/api/v1/app_auth/validate_token",
  headers: {
    Content-Type: application/json,
    token-type: Bearer,
    uid: uid_saved_from_previous_request,
    access-token: access_token_saved_from_previous_request,
    client: client_saved_from_previous_request,
    expiry: expiry_saved_from_previous_request
  }
}

Si votre token n'est plus valide, vous aurez une 401 et il faudra en redemander en effectuant la requête pour Obtenir ses tokens d'authentification