API de Autenticación de Aplicaciones
Primeros Pasos
La Autenticación de la Aplicación es una autenticación basada en tokens oAuth 2.0. Se crea un conjunto de credenciales para cada DSP en cada entorno.
❗ ❗ Al comenzar a trabajar en una API de DCP, necesitamos solicitar acceso creando un ticket de certificación en Jira, como se describe en la sección Actividades de Certificación con Jira. ❗ ❗
Si ya comenzaste a trabajar en una API y perdiste el acceso, crea un ticket de soporte como se describe en la sección Abrir un Ticket de Soporte.
Las credenciales normalmente nunca expirarán ni serán revocadas (a menos que dejes DCP).
Sin embargo, las credenciales pueden cambiar, por lo que tu implementación debe permitirte cambiarlas y usar nuevas credenciales fácilmente.
¡El token de acceso es válido por 30 minutos! (1799 segundos)
¿Por dónde empezar? ¡Léeme primero!
Antes de comenzar a trabajar en esta API, debe leer las siguientes secciones si aún no las ha revisado:
Información técnica
Características
Tipo de API | Tipo de DSP | Versión de DCP | Complejidad |
|---|---|---|---|
Obtener datos de BRP | DMS | V3 - Internacional | Baja |
Enviar datos a BRP | CRM | V4 - Norteamérica | Un poco más |
Transacción con BRP | | | Algo más |
Autenticación
Para llamar a la API de Autenticación de Aplicaciones, necesitas el client_id y client_secret proporcionados por el Equipo de DCP.
Asegúrate de usar el client_id y client_secret para que coincidan con el entorno en el que se llama a la API!
URL base
Prueba | https://qa-cloud-api.brp.com/dcp |
|---|---|
Producción | https://cloud-api.brp.com/dcp |
Referencia de API
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=REPLACE_ME_CLIENT_ID' \
--data-urlencode 'client_secret=REPLACE_ME_CLIENT_SECRET'curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/verify' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data-raw ''Cómo hacerlo
Esta sección proporciona información sobre cómo obtener resultados específicos con la API.
Obtener un token de acceso
Reemplace REPLACE_ME_CLIENT_ID y REPLACE_ME_CLIENT_SECRET con los valores correspondientes a sus credenciales en el entorno donde se realiza la llamada.
Si las credenciales REPLACE_ME_CLIENT_ID y REPLACE_ME_CLIENT_SECRET son válidas, la respuesta le proporcionará un access_token.
¡El token de acceso es válido por 30 minutos! (1799 segundos)
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=REPLACE_ME_CLIENT_ID' \
--data-urlencode 'client_secret=REPLACE_ME_CLIENT_SECRET'Verificar un token de acceso
Después de obtener su portador access_token, puede verificarlo llamando al endpoint verify de la API.
La respuesta de la API proporcionará el nombre de la aplicación si el token es válido y no ha expirado.
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/verify' \
--header 'Authorization: Bearer REPLACE_ME_ACCESS_TOKEN' \
--data-raw ''Manejo de errores
Esta sección presenta varios escenarios de llamadas incorrectas o erróneas, que resultan en mensajes de error y resultados incorrectos.
400 Solicitud incorrecta
El valor de grant_type es inválido o falta.
Verifique su llamada y asegúrese de incluir el grant_type adecuado.
401 No autorizado
El código de estado 401 Unauthorized generalmente es causado por el client_id o client_secret no válido.
Otra posible razón es que falta un parámetro en la solicitud.
Para resolver este problema, verifique que esté utilizando el conjunto de credenciales adecuado para el entorno en el que está llamando a la API de DCP.
Consulte la sección Entornos para obtener información sobre los entornos disponibles.
Requisitos DSP
Requisitos funcionales
ID | Tipo | |
|---|---|---|
1 | Obligatorio | El access_token debe renovarse automáticamente cada 29 minutos |
Actividades de certificación
No existen actividades de certificación específicas para la API de Autenticación de Aplicaciones; se valida a través de la API DCP utilizando la Autenticación de Aplicaciones.
Postman
Esta sección describe lo que está disponible en Postman para explorar la API.
Entornos
Hay un entorno de Postman disponible para probar la API de Autenticación de Aplicaciones. Este entorno de Postman contiene variables que son utilizadas por las consultas y están configuradas para conectarse al entorno de prueba.
Colecciones
La colección DSP - Autenticación de Aplicaciones contiene ejemplos de llamadas a la API para obtener un token de acceso y validar el token.