Authentification

L'authentification et la sécurisation de cette API est réalisée via l'utilisation de la technologie JSON Web token (https://jwt.io/). Afin de pouvoir interroger les différents services web de l'API, vous devez au préalable générer un jeton d'accès via une requête d'authentification, puis utiliser ce jeton pour l'ensemble des requêtes subséquentes que vous réaliserez sur Cloudspire.

Création d'un jeton de sécurité

Afin de générer un jeton de sécurité, il vous suffit de réaliser une requête HTTP d'authentification sur l'endpoint suivant :

POST @api/users/login

{
  /** @var string Identifiant de connexion fourni par Cloudspire */
  "username": "mySecretUsername",
  /** @var string Mot de passe fourni par Cloudspire */
  "password": "mySecretPassword",
  /** @var string Constante de connexion à l'API Partenaire */
  "context": "partners"
}

Réponse du service

Le service répond avec un code HTTP 200 OK en cas de réussite du traitement. Vous trouverez ci-dessous un exemple de réponse au format JSON.

Réponse au format JSON

  {
    "data": {
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJlMzIwZTA4YzE0ODQ0ZjY5ODVhYjMxMzZmMTc4ZjVhMiIsInVzZXJDbGFzcyI6IlBhcnRuZXIiLCJ1c2VyUmVmIjoiUDIwMDI1MDY2NSIsIm5iZiI6IjE1ODk0NDc0MDUiLCJpYXQiOiIxNTg5NDQ3NDA1IiwiZXhwIjoiMTU4OTQ1NDYwNSJ9.s-z8I6VSgclkzPr-xqHaRa9JO-NM5F4KxMCu9QYwkhk"
    },
    "meta": []
  }

Durée de validité d'un jeton de sécurité

Un jeton à une durée de validité de 2 heures. Un jeton expiré ne peut plus être utilisé afin d'accéder à l'API (Une erreur HTTP de code 403 : Forbidden sera levée si vous tentez d'accéder à une ressource avec un jeton expiré).

Lorsque vous réalisez une requête HTTP sur nos serveurs, un jeton de sécurité avec une date d'expiration prolongée (prolongé de 2 heures) vous sera renvoyé dans la réponse HTTP via le header Authorization. Si pour une raison quelconque, ce jeton venait à expirer, vous pouvez à tout moment réaliser de nouveau une requête d'authentification, afin de récupérer un nouveau jeton de sécurité.