Login

Connecte un utilisateur TrakIT et renvoie un jeton. Envoyez le jeton dans un en-tête Token avec chaque autre appel de l’API d’intégration, par exemple GetEntity ou GetLocations. Connectez-vous une fois et continuez à utiliser le jeton jusqu’à ce qu’un appel le refuse : voir Expiration du jeton. Lorsque l’intégration n’a plus besoin du jeton, mettez-y fin avec Logout. Seul un utilisateur disposant de l’accès à l’API peut se connecter.

Comment se connecter et lire la réponse : Authentification, Réponses.

POST /api/v1/Login
Content-Type: application/json

{
  "User": "jsmith",
  "Password": "your-password"
}

Champ	Obligatoire	Signification
`User`	Oui	L’identifiant utilisateur TrakIT de l’utilisateur, ou l’adresse e-mail de sa fiche utilisateur. Les majuscules n’ont pas d’importance.
`Password`	Oui	Le mot de passe de l’utilisateur. Il respecte la casse.

La requête n’a pas d’en-tête Token : Login est le seul appel qui n’en a pas besoin.

Règles

Règle	`Info` en cas d’échec
La requête a un corps JSON.	`LoginInfo must be supplied`
`User` est indiqué.	`User ID or Email must be supplied`
`Password` est indiqué.	`Password must be supplied`
`User` ne contient pas que des espaces.	`User ID or Email is required`
Un `User` contenant un `@` est une adresse e-mail bien formée.	`Email ... is invalid`
Il y a eu moins de cinq échecs de connexion avec ce `User` au cours des 30 dernières minutes.	`Five unsuccessful attempts made. Try again after 30 minutes.`
L’identifiant utilisateur ou l’adresse e-mail et le mot de passe sont corrects.	`User ID / Email or Password is incorrect`
La fiche utilisateur a une adresse e-mail.	`Sign In Permission Denied`
La fiche utilisateur passe le contrôle d’intégrité de TrakIT. Sinon, contactez le support TrakIT.	`User Hash verification failed`
L’utilisateur n’est pas verrouillé.	`User account is locked`
Votre installation TrakIT a été mise à jour au cours des 90 derniers jours.	`Sign-in is disabled because this TrakIT installation has not been updated in the last 90 days. ...`
L’utilisateur peut se connecter quelque part : au moins un mode d’accès est activé.	`User account not permitted to logon`
L’utilisateur a le mode d’accès API.	`User account is not permitted to sign in from the API`
Le mot de passe de l’utilisateur n’a pas expiré, si votre société fait expirer les mots de passe. Voir Expiration du mot de passe.	`Your password has expired. Sign in to TrakIT in a web browser to change it.`
L’utilisateur n’a pas d’authentification à deux facteurs : `Login` ne peut pas recevoir de code à usage unique.	`Two-factor authentication is on for this user, and the API cannot take a code. Use an API user without two-factor authentication.`
Les validations de connexion de votre société, s’il y en a (User > Login dans Validations et actions), sont satisfaites.	Le message propre à la validation

Un utilisateur avec authentification à deux facteurs ne peut pas utiliser l’API d’intégration, quel que soit le type de code qu’il utilise : utilisez un utilisateur qui ne l’a pas. Login n’envoie aucun code à un tel utilisateur.

Réponse

En cas de succès, Info contient le jeton. RetInfo vaut null, et RowsAffected et Identity valent 0.

{
  "Code": 1,
  "Info": "your-token",
  "RetInfo": null,
  "RowsAffected": 0,
  "Scalar": null,
  "Identity": 0
}

Traitez le jeton comme une chaîne opaque : renvoyez-le exactement tel que vous l’avez reçu, et gardez-le aussi secret que le mot de passe.

Notes

Chaque Login réussi ouvre une nouvelle session, listée comme session API dans l’onglet Session Log de l’utilisateur. Les jetons des connexions précédentes restent valides jusqu’à ce qu’ils prennent fin : ne vous reconnectez donc que lorsqu’un appel répond Token invalid or expired.
Si le même utilisateur est connecté à TrakIT dans un navigateur web depuis une autre connexion internet, Login l’y déconnecte : la prochaine page qu’il ouvre le ramène à la page de connexion. Réservez un utilisateur à l’intégration.
Un mot de passe erroné, ou un identifiant utilisateur ou une adresse e-mail qui n’existe pas, compte comme un échec de connexion. Après cinq échecs en 30 minutes, TrakIT refuse ce User jusqu’à ce que le plus ancien d’entre eux date de plus de 30 minutes, même avec le bon mot de passe. Toutes les trois heures, TrakIT envoie par e-mail à ses administrateurs système un récapitulatif des échecs de connexion survenus depuis le précédent.
Les actions de connexion de votre société, s’il y en a, s’exécutent sur Login comme pour une connexion dans un navigateur web.
TrakIT journalise chaque appel à Login avec le User envoyé, jamais le mot de passe.