Recuperar una configuración de credenciales
platform.adobe.io/data/core/activation/authoring/credentialsEsta página ejemplifica la solicitud de API y la carga útil que puede utilizar para recuperar una configuración de credenciales mediante el extremo de API /authoring/credentials.
Cuándo usar el extremo de API /credentials when-to-use
/credentials. En su lugar, puede configurar la información de autenticación para su destino a través de los parámetros customerAuthenticationConfigurations del extremo /destinations.Use este extremo de API para crear una configuración de credenciales únicamente si existe un sistema de autenticación global entre Adobe y la plataforma de destino y el cliente Experience Platform no necesita proporcionar credenciales de autenticación para conectarse a su destino. En este caso, debe crear una configuración de credenciales utilizando el extremo de API /credentials.
Cuando use un sistema de autenticación global, debe establecer "authenticationRule":"PLATFORM_AUTHENTICATION" en la configuración de envío de destino al crear una nueva configuración de destino. A continuación, debe crear una configuración de credenciales y pasar el ID del objeto de credencial en el parámetro authenticationId en la configuración de entrega de destino.
Introducción a las operaciones de API de credenciales get-started
Antes de continuar, revisa la guía de introducción para obtener información importante que necesitas conocer para poder realizar llamadas a la API correctamente, incluyendo cómo obtener el permiso de creación de destino requerido y los encabezados requeridos.
Recuperar una configuración de credenciales retrieve
Puede recuperar una configuración de credencial existing realizando una solicitud GET al extremo /authoring/credentials.
Formato de API
Utilice el siguiente formato de API para recuperar todas las configuraciones de credenciales de su cuenta.
GET /authoring/credentials
Utilice el siguiente formato de API para recuperar una configuración de credenciales específica, definida por el parámetro {INSTANCE_ID}.
GET /authoring/credentials/{INSTANCE_ID}
Las dos solicitudes siguientes recuperan todas las configuraciones de credenciales de su organización de IMS o una configuración de credenciales específica, en función de si pasa el parámetro INSTANCE_ID en la solicitud.
Seleccione cada pestaña a continuación para ver la carga útil correspondiente.
| accordion | ||
|---|---|---|
| Solicitud | ||
|
| accordion | ||
|---|---|---|
| Respuesta | ||
|
Una respuesta correcta devuelve el estado HTTP 200 con una lista de configuraciones de credenciales a las que tiene acceso, en función del IMS Org ID y el nombre de la zona protegida que ha utilizado. Un(a)
|
| accordion | ||||||||
|---|---|---|---|---|---|---|---|---|
| Solicitud | ||||||||
|
| accordion | ||
|---|---|---|
| Respuesta | ||
|
Una respuesta correcta devuelve el estado HTTP 200 con los detalles de la configuración de credenciales correspondientes a
|
Administración de errores de API error-handling
Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Experience Platform.
Próximos pasos next-steps
Después de leer este documento, ahora sabe cómo recuperar detalles acerca de las configuraciones de credenciales mediante el extremo de API /authoring/credentials. Lee cómo usar Destination SDK para configurar tu destino para saber dónde encaja este paso en el proceso de configuración de tu destino.