Crear una configuración de credenciales
Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
Extremo de API: platform.adobe.io/data/core/activation/authoring/credentials
Esta página ejemplifica la solicitud de API y la carga útil que puede utilizar para crear una configuración de credenciales mediante /authoring/credentials
Extremo de API.
Cuándo usar el /credentials
Extremo de API when-to-use
En la mayoría de los casos, no necesita usar el /credentials
Extremo de API. En su lugar, puede configurar la información de autenticación para su destino mediante el customerAuthenticationConfigurations
parámetros del /destinations
punto final.
Utilice este extremo de API para crear una configuración de credenciales solo si hay un sistema de autenticación global entre el Adobe y la plataforma de destino, y la variable Platform el cliente no necesita proporcionar credenciales de autenticación para conectarse a su destino. En este caso, debe crear una configuración de credenciales de utilizando /credentials
Extremo de API.
Al utilizar un sistema de autenticación global, debe establecer "authenticationRule":"PLATFORM_AUTHENTICATION"
en el envío de destino configuración, cuando creación de una nueva configuración de destino.
Todos los nombres y valores de parámetro admitidos por el Destination SDK son distingue mayúsculas de minúsculas. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.
Introducción a las operaciones de API de credenciales get-started
Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API, incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.
Crear una configuración de credenciales create
Puede crear una nueva configuración de credenciales realizando una POST
solicitud a la /authoring/credentials
punto final.
Formato de API
POST /authoring/credentials
Las siguientes solicitudes crean nuevas configuraciones de credenciales, definidas por los parámetros proporcionados en la carga útil.
Seleccione cada pestaña a continuación para ver la carga útil correspondiente.
Básico
Crear una configuración de credenciales básica
accordion |
Solicitud |
code language-shell |
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 '
{
"basicAuthentication":{
"url":"string",
"username":"string",
"password":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 layout-auto |
|
|
Parámetro |
Tipo |
Descripción |
url |
Cadena |
URL del proveedor de autorización |
username |
Cadena |
Nombre de usuario de inicio de sesión de configuración |
password |
Cadena |
Contraseña de inicio de sesión de configuración de credenciales |
|
accordion |
Respuesta |
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de credenciales recién creada. |
Amazon S3
Crear un Amazon S3 configuración de credenciales
accordion |
Solicitud |
code language-shell |
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 '
{
"s3Authentication":{
"accessId":"string",
"secretKey":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
Parámetro |
Tipo |
Descripción |
accessId |
Cadena |
Amazon S3 ID de acceso |
secretKey |
Cadena |
Amazon S3 clave secreta |
|
accordion |
Respuesta |
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de credenciales recién creada. |
SSH
Creación de una configuración de credenciales SSH
accordion |
Solicitud |
code language-shell |
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 '
{
"sshAuthentication":{
"username":"string",
"sshKey":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
Parámetro |
Tipo |
Descripción |
username |
Cadena |
Nombre de usuario de inicio de sesión de configuración |
sshKey |
Cadena |
Clave SSH para SFTP con autenticación SSH |
|
accordion |
Respuesta |
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de credenciales recién creada. |
Azure Data Lake Storage
Crear un Azure Data Lake Storage configuración de credenciales
accordion |
Solicitud |
code language-shell |
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 '
{
"azureAuthentication":{
"url":"string",
"tenant":"string",
"servicePrincipalId":"string",
"servicePrincipalKey":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 layout-auto |
|
|
Parámetro |
Tipo |
Descripción |
url |
Cadena |
URL del proveedor de autorización |
tenant |
Cadena |
inquilino de Azure Data Lake Storage |
servicePrincipalId |
Cadena |
ID principal del servicio de Azure para el almacenamiento de Azure Data Lake |
servicePrincipalKey |
Cadena |
Clave principal del servicio de Azure para el almacenamiento de Azure Data Lake |
|
accordion |
Respuesta |
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de credenciales recién creada. |
Almacenamiento de Azure Blob
Crear un Azure Blob Storage configuración de credenciales
accordion |
Solicitud |
code language-shell |
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 '
{
"azureConnectionStringAuthentication":{
"connectionString":"string"
}
}
|
table 0-row-3 1-row-3 layout-auto |
|
|
Parámetro |
Tipo |
Descripción |
connectionString |
Cadena |
Azure Blob Storage cadena de conexión |
|
accordion |
Respuesta |
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de credenciales recién creada. |
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 Platform.
Pasos siguientes next-steps
Después de leer este documento, ahora sabe cuándo usar el punto de conexión de credenciales y cómo establecer una configuración de credenciales mediante /authoring/credentials
Extremo de API leído cómo utilizar Destination SDK para configurar el destino para comprender dónde encaja este paso en el proceso de configuración del destino.