Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

Instructions

Sommaire
minLevel2
exclude.*Disclaimer.*

POST {url}/localtrac/login

L'authentification est utilisée pour obtenir un jeton valide que votre application utilisera pour se connecter à toutes les routes de l'API. Le jeton a une durée de conservation de 15 minutes à partir de son acquisition, après quoi il doit être racheté. Lorsque vous utilisez le jeton dans une demande, vous êtes connecté au nom de l'utilisateur fourni lors de l'authentification et êtes limité à la limitation de cet utilisateur (voir les rôles des utilisateurs et leurs permissions).

Requête

En-têtes

Accept

application/json

Content-type

application/json

Body

Bloc de code
languagejson
{
	"username": <(string) username>,
	"password": <(string) password>
}

username

Nom d'utilisateur de l'utilisateur pour se connecter

password

Mot de passe de l'utilisateur

Réponse (200) - Succès

En-têtes

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code
languagejson
{
  "success": true,
  "token": <(string) token>
}

success

Le jeton a été acquis

token

Le jeton à utiliser dans l'en-tête d'autorisation pour la demande

Réponse (401,503) - Accès autorisé

En-têtes

Content-type

application/json

Cache-Control

no-cache,private

Connection

close

Body

Bloc de code
languagejson
{
  "code": <(string) code of error),
  "message": <(string) message of error)
}

code

Codes d'erreur:

  • 401.unauthorized: Lorsque vous fournissez des informations d'identification incorrectes ou un jeton expiré

  • 503.maintenance : Lorsque le serveur est actuellement en maintenance

message

Description conviviale du code d'erreur par les développeurs. Ex: «Informations d'identification non valides fournies / Invalid credential provided»

...