Authentification OAuth2

Support DQE
Support DQE
  • Mise à jour

Utilisez OAuth2 pour générer un token Bearer temporaire avant d'appeler les API DQE. Le flux utilise votre code de licence, votre client secret et le scope demandé pour renvoyer un jeton d'accès avec une durée de validité limitée.

Requête GET

Utilisez ce endpoint pour générer un token d'accès OAuth2 avec la méthode GET.

Endpoint

https://{SERVER_ADDRESS}/oauth/access_token/?client_secret={CLIENT_SECRET}&scope={SCOPE}&client_id={LICENCE_CODE}

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Valeur Description Obligatoire/Optionnel
SERVER_ADDRESS {SERVER_ADDRESS} Adresse du serveur DQE qui traitera les données. Obligatoire
client_id {LICENCE_CODE} Numéro qui vous a été attribué comme code de licence. Obligatoire
client_secret {CLIENT_SECRET} Phrase secrète fournie par DQE Software. Obligatoire
scope {SCOPE}

Définit le scope d'autorisation demandé. Les valeurs disponibles sont :

  • client_address — API DQE Adresse
  • client_phone — API DQE Téléphone
  • client_email — API DQE Email
  • client_idcheck — API DQE ID Check
  • client_general — plusieurs API DQE
  • client_b2b — API DQE B2B
  • client_civility — API DQE Nom
 Obligatoire

Requête POST

Utilisez ce endpoint pour générer un token d'accès OAuth2 avec la méthode POST.

Endpoint

https://{SERVER_ADDRESS}/oauth/access_token/

Méthode : POST

Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.

Paramètre Valeur Description Obligatoire/Optionnel
client_id {LICENCE_CODE} Numéro qui vous a été attribué comme code de licence. Obligatoire
client_secret {CLIENT_SECRET} Phrase secrète fournie par DQE Software. Obligatoire
scope {SCOPE}

Définit le scope d'autorisation demandé. Les valeurs disponibles sont :

  • client_address — API DQE Adresse
  • client_phone — API DQE Téléphone
  • client_email — API DQE Email
  • client_idcheck — API DQE ID Check
  • client_general — plusieurs API DQE
  • client_b2b — API DQE B2B
  • client_civility — API DQE Nom
 Obligatoire

Réponse

Réponse en cas de succès

Si l'authentification réussit, l'API renvoie un dictionnaire JSON contenant les clés suivantes :

Clé Description Type
access_token Token temporaire utilisé pour appeler le service. STRING
token_type Bearer — type de token autorisé. STRING
expires_in Durée de validité du token, en secondes. STRING
refresh_token Token utilisé pour prolonger votre session. STRING

Exemple :

{
  "access_token": "TK948869a6f873adb622enhoaGeVY2iRaptqlmpplGeWZA",
  "token_type": "Bearer",
  "expires_in": "300",
  "refresh_token": "*TK9bdd05f8e9d3c905834bdeqaUlGFll2iRaplll29mZmtkZQ"
}

Réponses d'erreur

Type d'erreur Exemple de requête Type de réponse
Paramètre client_id manquant https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address 400 Error (Invalid Request)
Paramètre client_id vide https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id= 400 Error (Invalid Request)
client_id incorrect (expiré, hors scope, ou inexistant) https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id={INCORRECT_LICENCE_CODE} 400 Error (Invalid Client)
client_id n'autorise pas le scope demandé https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id={LICENCE_CODE_NOT_AUTHORIZED} 400 Error (Unauthorized Client)
Valeur de paramètre scope inconnue https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client&client_id={LICENCE_CODE} 400 Error (Unsupported Grant Type)
Paramètre client_secret manquant ou vide https://{SERVER_ADDRESS}/oauth/access_token/?scope=client_address&client_id={LICENCE_CODE}
https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=&scope=client_address&client_id={LICENCE_CODE} 		400 Error (Invalid Request)
Paramètre scope manquant ou vide https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&client_id={LICENCE_CODE}
https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=&client_id={LICENCE_CODE} 		400 Error (Invalid Request)
Faute de frappe dans un paramètre https://{SERVER_ADDRESS}/oauth/access_token/?client_scret=abcd&scope=client_address&client_id={LICENCE_CODE} 500 Error

Documentation Swagger

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0