Punto de conexión de API: platform.adobe.io/data/core/activation/authoring/credentials
En esta página se enumeran y describen todas las operaciones de API que puede realizar mediante la /authoring/credentials
extremo de API.
Para obtener una descripción de la funcionalidad admitida por este punto final, lea:
/credentials
Punto de conexión de APIEn la mayoría de los casos, usted no es necesario usar la variable /credentials
extremo de API. En su lugar, puede configurar la información de autenticación de su destino mediante la variable customerAuthenticationConfigurations
parámetros de la variable /destinations
punto final. Lectura Configuración de autenticación para obtener más información.
Utilice este extremo de API y seleccione PLATFORM_AUTHENTICATION
en el configuración de destino si hay un sistema de autenticación global entre el Adobe y el destino y la variable Platform El cliente no necesita proporcionar credenciales de autenticación para conectarse al destino. En este caso, debe crear un objeto credentials utilizando la variable /credentials
extremo de API.
Antes de continuar, revise la guía de introducción para obtener información importante que debe conocer para realizar llamadas correctamente a la API de , incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.
Puede crear una nueva configuración de credenciales realizando una solicitud de POST al /authoring/credentials
punto final.
Formato de API
POST /authoring/credentials
Solicitud
La siguiente solicitud crea una nueva configuración de credenciales, configurada por los parámetros proporcionados en la carga útil. La carga útil siguiente incluye todos los parámetros aceptados por la variable /authoring/credentials
punto final. Tenga en cuenta que no es necesario agregar todos los parámetros en la llamada de y que la plantilla se puede personalizar, según los requisitos de la API.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"oauth2UserAuthentication":{
"url":"string",
"clientId":"string",
"clientSecret":"string",
"username":"string",
"password":"string",
"header":"string"
},
"oauth2ClientAuthentication":{
"url":"string",
"clientId":"string",
"clientSecret":"string",
"header":"string",
"developerToken":"string"
},
"oauth2AccessTokenAuthentication":{
"accessToken":"string",
"expiration":"string",
"username":"string",
"userId":"string",
"url":"string",
"header":"string"
},
"oauth2RefreshTokenAuthentication":{
"refreshToken":"string",
"expiration":"string",
"clientId":"string",
"clientSecret":"string",
"url":"string",
"header":"string"
},
"s3Authentication":{
"accessId":"string",
"secretKey":"string"
},
"sshAuthentication":{
"username":"string",
"sshKey":"string"
},
"azureAuthentication":{
"url":"string",
"tenant":"string",
"servicePrincipalId":"string",
"servicePrincipalKey":"string"
},
"azureConnectionStringAuthentication":{
"connectionString":"string"
},
"basicAuthentication":{
"url":"string",
"username":"string",
"password":"string"
}
}
Parámetro | Tipo | Descripción |
---|---|---|
username |
Cadena | Credenciales configuración nombre de usuario inicio de sesión |
password |
Cadena | Credenciales configuración contraseña de inicio de sesión |
url |
Cadena | URL del proveedor de autorización |
clientId |
Cadena | ID de cliente de credenciales de cliente/aplicación |
clientSecret |
Cadena | Secreto de cliente de las credenciales de cliente/aplicación |
accessToken |
Cadena | Token de acceso proporcionado por el proveedor de autorización |
expiration |
Cadena | El tiempo de vida del token de acceso |
refreshToken |
Cadena | Actualizar token proporcionado por el proveedor de autorización |
header |
Cadena | Cualquier encabezado necesario para la autorización |
accessId |
Cadena | ID de acceso de Amazon S3 |
secretKey |
Cadena | Clave secreta de Amazon S3 |
sshKey |
Cadena | Clave SSH para SFTP con autenticación SSH |
tenant |
Cadena | Inquilino de almacenamiento de Azure Data Lake |
servicePrincipalId |
Cadena | ID principal de Azure Service para el almacenamiento de Azure Data Lake |
servicePrincipalKey |
Cadena | Clave principal de Azure Service para el almacenamiento de Azure Data Lake |
connectionString |
Cadena | Cadena de conexión de almacenamiento del blob de Azure |
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de credenciales recién creada.
Puede recuperar una lista de todas las configuraciones de credenciales para su organización IMS realizando una solicitud de GET al /authoring/credentials
punto final.
Formato de API
GET /authoring/credentials
Solicitud
La siguiente solicitud recuperará la lista de configuraciones de credenciales a las que tiene acceso, según la configuración de la organización y el entorno limitado de IMS.
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
Respuesta
La siguiente respuesta devuelve el estado HTTP 200 con una lista de configuraciones de credenciales a las que tiene acceso, según el ID de organización de IMS y el nombre del simulador para pruebas que utilizó. One instanceId
corresponde a la plantilla para una configuración de credenciales. La respuesta se trunca para su brevedad.
{
"items":[
{
"instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
"createdDate":"2021-06-07T06:41:48.641943Z",
"lastModifiedDate":"2021-06-07T06:41:48.641943Z",
"type":"OAUTH2_USER_CREDENTIAL",
"name":"yourdestination",
"oauth2UserAuthentication":{
"url":"ABCD",
"clientId":"ABCDEFGHIJKL",
"clientSecret":"clientsecret",
"username":"username",
"password":"password",
"header":"header"
}
}
]
}
Puede actualizar una configuración de credenciales existente realizando una solicitud de PUT al /authoring/credentials
y proporcionando el ID de instancia de la configuración de credenciales que desea actualizar. En el cuerpo de la llamada, proporcione la configuración de credenciales actualizada.
Formato de API
PUT /authoring/credentials/{INSTANCE_ID}
Parámetro | Descripción |
---|---|
{INSTANCE_ID} |
El ID de la configuración de credenciales que desea actualizar. |
Solicitud
La siguiente solicitud actualiza una configuración de credenciales existente, configurada por los parámetros proporcionados en la carga útil.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/n55affa0-3747-4030-895d-1d1236bb3680 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
"createdDate":"2021-06-07T06:41:48.641943Z",
"lastModifiedDate":"2021-06-07T06:41:48.641943Z",
"type":"OAUTH2_USER_CREDENTIAL",
"name":"yourdestination",
"oauth2UserAuthentication":{
"url":"ABCD",
"clientId":"ABCDEFGHIJKL",
"clientSecret":"clientsecret",
"username":"username",
"password":"password",
"header":"header"
}
}
Puede recuperar información detallada sobre una configuración de credenciales específica realizando una solicitud de GET al /authoring/credentials
y proporcionando el ID de instancia de la configuración de credenciales que desea actualizar.
Formato de API
GET /authoring/credentials/{INSTANCE_ID}
Parámetro | Descripción |
---|---|
{INSTANCE_ID} |
El ID de la configuración de credenciales que desea recuperar. |
Solicitud
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials/n55affa0-3747-4030-895d-1d1236bb3680 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información detallada sobre la configuración de credenciales especificada.
{
"instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
"createdDate":"2021-06-07T06:41:48.641943Z",
"lastModifiedDate":"2021-06-07T06:41:48.641943Z",
"type":"OAUTH2_USER_CREDENTIAL",
"name":"yourdestination",
"oauth2UserAuthentication":{
"url":"ABCD",
"clientId":"ABCDEFGHIJKL",
"clientSecret":"clientsecret",
"username":"username",
"password":"password",
"header":"header"
}
}
Puede eliminar la configuración de credenciales especificada realizando una solicitud de DELETE al /authoring/credentials
y proporcionando el ID de la configuración de credenciales que desea eliminar en la ruta de solicitud.
Formato de API
DELETE /authoring/credentials/{INSTANCE_ID}
Parámetro | Descripción |
---|---|
{INSTANCE_ID} |
La variable id de la configuración de credenciales que desea eliminar. |
Solicitud
curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/credentials/n55affa0-3747-4030-895d-1d1236bb3680 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 junto con una respuesta HTTP vacía.
Los extremos de la API del Destination SDK siguen los principios generales del mensaje de error de la API del Experience Platform. Consulte Códigos de estado de API y errores en el encabezado de la solicitud en la guía de solución de problemas de Platform.
Después de leer este documento, ahora sabe cuándo utilizar el extremo de credenciales y cómo configurar una configuración de credenciales utilizando la variable /authoring/credentials
Punto final de API o /authoring/destinations
punto final. Lectura cómo usar Destination SDK para configurar el destino para comprender dónde encaja este paso en el proceso de configuración de su destino.