Devis immédiat en ligne à partir de 9€ HT / mois

Obtenir mon devis
Devis
Traceurs GPS pour les pros à partir de 9 € HT / mois

API QWS — Authentification

Sommaire de la documentation

  1. Authentification/auth, /auth/refresh
  2. Régions, sites & groupes/regions, /sites, /groups
  3. Véhicules & chauffeurs/vehicles, /drivers
  4. Suivi en temps réel/vehicles/live, /drivers/live
  5. Résumés de trajets/vehicles/tripsummary, /drivers/tripsummary
  6. Détail des trajets/vehicles/trips, /drivers/trips
  7. Itinéraires détaillés/vehicles/route, /drivers/route
  8. Kilométrage/vehicles/odometer
  9. Gestion des véhicules/vehicles/management
  10. Lieux personnalisés/locations
  11. Paramètres utilisateur/settings

/auth

POST /auth

https://qws.quartix.net/api/v2/auth

Fournit un jeton d'authentification (AccessToken) et un jeton de rafraîchissement (RefreshToken) à partir des identifiants fournis. Les deux jetons sont des jetons web JSON. Le serveur tente de définir ces jetons sous forme de cookies et les renvoie également dans le corps de la réponse. Si le client prend en charge les cookies, aucune action supplémentaire n'est requise : la soumission et le rafraîchissement des jetons sont gérés automatiquement. Si le client ne prend pas en charge les cookies, les jetons doivent être stockés côté client sous forme de chaînes de caractères, le jeton d'authentification doit être transmis dans l'en-tête à chaque appel, et /auth/refresh doit être utilisé avec le jeton de rafraîchissement pour obtenir de nouveaux jetons lorsque le jeton d'authentification expire. Deux formes d'authentification sont prises en charge : la connexion directe avec les identifiants fournis, et — pour certains identifiants — l'impersonation d'autres utilisateurs. Dans ce second cas, les identifiants du superuser ainsi que les informations de l'utilisateur à impersonner doivent être fournis.

Paramètres

NomDescriptionTypeEmplacement
SubscriberIDL'identifiant de l'abonné.stringformData
UserNameLe nom d'utilisateur.stringformData
PasswordLe mot de passe correspondant à l'abonné et au nom d'utilisateur fournis.PasswordformData
ApplicationL'application à l'origine de la requête.stringformData
SiteNameLe site auquel accéder (si le SubscriberID donne accès aux données de plusieurs clients).stringformData
UserLe nom d'utilisateur pour le site à accéder (si le SubscriberID donne accès aux données de plusieurs clients).stringformData

Réponses

200 — Réponse réussie
{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": {
    "AccessToken": "",
    "RefreshToken": ""
  }
}
403 — Échec de l'authentification
{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

/auth/refresh

POST /auth/refresh

https://qws.quartix.net/api/v2/auth/refresh

Fournit un jeton d'authentification à partir d'un jeton de rafraîchissement transmis. Ce endpoint permet aux clients de choisir de ne pas envoyer le RefreshToken à chaque requête et de réagir à la place à une réponse 401.

Paramètres

NomDescriptionTypeEmplacement
RefreshTokenLe jeton de rafraîchissement fourni lors de l'authentification. Ce jeton a une durée de vie plus longue que l'AccessToken et sera utilisé lorsque l'AccessToken aura expiré pour obtenir un nouvel AccessToken. Les jetons de rafraîchissement peuvent être révoqués. Lorsqu'un jeton de rafraîchissement est utilisé, les droits d'accès de l'utilisateur sont actualisés (en cas de changement de rôle/permissions depuis la dernière connexion ou utilisation de l'AccessToken).stringformData

Réponses

200 — Réponse réussie
{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": {
    "AccessToken": "",
    "RefreshToken": ""
  }
}
403 — Échec de l'authentification
{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}