Skip to content

authentification.md

Latest commit

 

History

History
30 lines (23 loc) · 1.1 KB

authentification.md

File metadata and controls

30 lines (23 loc) · 1.1 KB

Authentification

Il est obligatoire de s'authentifier afin de pouvoir communiquer avec l'API

L'authentification à l'API est effectuée via JSON Web Token. Authentifiez votre compte lors de l'utilisation de l'API en incluant votre accessToken dans les headersde votre requête. Ne partagez jamais ce token avec quiconque.

Toutes les demandes d'API doivent être effectuées sur HTTPS. Les appels effectués sur HTTP simple échoueront. Les demandes API sans authentification échoueront également.

{% method %}

/api/auth/jwt - POST

Il faut passer les paramètres usernameOrEmailAddress et password à cette méthode afin de recevoir votre token. Il faudra stocker ce token de votre côté, car celui-ci est requis pour chaque appel subséquent.

{% sample lang="bash" %}

curl http://app.userboat.com/api/auth/jwt \
   -H "Content-Type: application/json"
   -d '{"usernameOrEmailAddress":"VOTRE_EMAIL","password":"VOTRE_PASSWORD"}'

{% common %}

{
  "accessToken": "VOTRE_CLEF",
  "encryptedAccessToken": null,
  "expireInSeconds": 86400,
  "userId": 0
}

{% endmethod %}