Autenticación y acceso a la API de Privacy Service
Esta guía proporciona una introducción a los conceptos principales que debe conocer antes de intentar realizar llamadas a la API de Adobe Experience Platform Privacy Service.
Requisitos previos prerequisites
Esta guía requiere una comprensión práctica de Privacy Service y de cómo le permite administrar las solicitudes de acceso y eliminación de sus interesados (clientes) en las aplicaciones de Adobe Experience Cloud.
Para crear credenciales de acceso para la API, un administrador de su organización debe haber configurado previamente perfiles de producto para un Privacy Service en Adobe Admin Console. El perfil de producto que asigna a una integración de API determina qué permisos tiene la integración al acceder a las funciones de Privacy Service. Consulte la guía sobre administración de permisos de Privacy Service para obtener más información.
Recopilación de valores para los encabezados obligatorios gather-values-required-headers
Para realizar llamadas a la API de Privacy Service, primero debe recopilar las credenciales de acceso para utilizarlas en los encabezados obligatorios:
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
Estos valores se generan usando Adobe Developer Console. {ORG_ID} y {API_KEY} solo deben generarse una vez y podrán reutilizarse en futuras llamadas a la API. Sin embargo, {ACCESS_TOKEN} es temporal y debe regenerarse cada 24 horas.
Los pasos para generar estos valores se tratan en detalle a continuación.
Configuración única one-time-setup
Vaya a la consola de desarrollador de Adobe e inicie sesión con su Adobe ID. A continuación, siga los pasos descritos en el tutorial sobre la creación de un proyecto vacío en la documentación de la consola de desarrollador.
Una vez que haya creado un nuevo proyecto, seleccione Agregar al proyecto y elija API en el menú desplegable.
Seleccione la API de Privacy Service select-privacy-service-api
Aparece la pantalla Añadir una API. Seleccione Experience Cloud para reducir la lista de API disponibles y, a continuación, seleccione la tarjeta de API de Privacy Service antes de seleccionar Siguiente.
A continuación, seleccione el tipo de autenticación para generar tokens de acceso y acceder a la API de Privacy Service.
Asignación de permisos mediante perfiles de producto product-profiles
El paso de configuración final es seleccionar los perfiles de producto desde los que heredará esta integración sus permisos. Si selecciona más de un perfil, sus conjuntos de permisos se combinarán para la integración.
Cuando termine, seleccione Guardar la API configurada.
Una vez agregada la API al proyecto, la página API de Privacy Service del proyecto muestra las siguientes credenciales, que son necesarias en todas las llamadas a las API de Privacy Service:
{API_KEY}(ID de cliente){ORG_ID}(ID de organización)
Autenticación para cada sesión authentication-each-session
La credencial final necesaria que debe recopilar es su {ACCESS_TOKEN}, que se usa en el encabezado Autorización. A diferencia de los valores de {API_KEY} y {ORG_ID}, se debe generar un nuevo token cada 24 horas para seguir usando la API.
En general, hay dos métodos para generar un token de acceso:
- Genere el token manualmente para pruebas y desarrollo.
- Automatice la generación de tokens para integraciones de API.
Generación manual de un token manual-token
Para generar manualmente un nuevo {ACCESS_TOKEN}, vaya a Credenciales > Servidor a servidor OAuth y seleccione Generar token de acceso, como se muestra a continuación.
Se genera un nuevo token de acceso y se proporciona un botón para copiar el token en el portapapeles. Este valor se utiliza para el encabezado Authorization requerido y debe proporcionarse con el formato Bearer {ACCESS_TOKEN}.
Automatización de la generación de tokens auto-token
También puede utilizar un entorno y una colección de Postman para generar tokens de acceso. Para obtener más información, lea la sección sobre el uso de Postman para autenticar y probar las llamadas a la API en la guía de autenticación de la API del Experience Platform.
Lectura de llamadas de API de muestra read-sample-api-calls
Cada guía de extremo proporciona llamadas de API de ejemplo para demostrar cómo dar formato a sus solicitudes. Estas incluyen rutas, encabezados obligatorios y cargas de solicitud con el formato correcto. También se proporciona el JSON de muestra devuelto en las respuestas de la API. Para obtener información sobre las convenciones utilizadas en la documentación de las llamadas de API de ejemplo, consulte la sección sobre cómo leer las llamadas de API de ejemplo en la guía de introducción a las API de Platform.
Pasos siguientes next-steps
Ahora que comprende qué encabezados utilizar, está listo para empezar a realizar llamadas a la API de Privacy Service. Seleccione una de las guías de extremos para empezar: