Autenticación OAuth2

Support DQE
Support DQE
  • Actualización

Utilice OAuth2 para generar un Bearer token temporal antes de llamar a las API de DQE. El flujo utiliza su código de licencia, su client secret y el scope solicitado para devolver un token de acceso con un período de validez limitado.

Solicitud GET

Utilice este endpoint para generar un token de acceso OAuth2 mediante el método GET.

Endpoint

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

Reemplace los valores entre llaves con su propia información:

Parámetro Valor Descripción Obligatorio/Opcional
SERVER_ADDRESS {SERVER_ADDRESS} Dirección del servidor DQE que procesará los datos. Obligatorio
client_id {LICENCE_CODE} Número asignado como su código de licencia. Obligatorio
client_secret {CLIENT_SECRET} Frase de contraseña proporcionada por DQE Software. Obligatorio
scope {SCOPE}

Define el ámbito de autorización solicitado. Los valores disponibles incluyen:

  • client_address — DQE Address APIs
  • client_phone — DQE Phone APIs
  • client_email — DQE Email APIs
  • client_idcheck — DQE ID Check APIs
  • client_general — múltiples API de DQE
  • client_b2b — DQE B2B APIs
  • client_civility — DQE Name APIs
 Obligatorio

Solicitud POST

Utilice este endpoint para generar un token de acceso OAuth2 mediante el método POST.

Endpoint

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

Método: POST

Añada los parámetros siguientes en el cuerpo de la solicitud usando x-www-form-urlencoded.

Parámetro Valor Descripción Obligatorio/Opcional
client_id {LICENCE_CODE} Número asignado como su código de licencia. Obligatorio
client_secret {CLIENT_SECRET} Frase de contraseña proporcionada por DQE Software. Obligatorio
scope {SCOPE}

Define el ámbito de autorización solicitado. Los valores disponibles incluyen:

  • client_address — DQE Address APIs
  • client_phone — DQE Phone APIs
  • client_email — DQE Email APIs
  • client_idcheck — DQE ID Check APIs
  • client_general — múltiples API de DQE
  • client_b2b — DQE B2B APIs
  • client_civility — DQE Name APIs
 Obligatorio

Respuesta

Respuesta correcta

Si la autenticación se realiza correctamente, la API devuelve un diccionario JSON que contiene las siguientes claves:

Clave Descripción Tipo
access_token Token temporal utilizado para llamar al servicio. STRING
token_type Bearer — tipo de token autorizado. STRING
expires_in Período de validez del token, en segundos. STRING
refresh_token Token utilizado para prolongar su sesión. STRING

Ejemplo:

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

Respuestas de error

Tipo de error Ejemplo de solicitud Tipo de respuesta
Falta el parámetro client_id https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address 400 Error (Invalid Request)
Parámetro client_id vacío https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id= 400 Error (Invalid Request)
client_id incorrecto (caducado, fuera de ámbito o inexistente) https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id={INCORRECT_LICENCE_CODE} 400 Error (Invalid Client)
client_id no autoriza el scope solicitado https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id={LICENCE_CODE_NOT_AUTHORIZED} 400 Error (Unauthorized Client)
Valor del parámetro scope desconocido https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client&client_id={LICENCE_CODE} 400 Error (Unsupported Grant Type)
Parámetro client_secret faltante o vacío 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)
Parámetro scope faltante o vacío 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)
Error tipográfico en un parámetro https://{SERVER_ADDRESS}/oauth/access_token/?client_scret=abcd&scope=client_address&client_id={LICENCE_CODE} 500 Error

Documentación Swagger

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0