Criar uma configuração de credencial

Esta página exemplifica a solicitação de API e a carga que você pode usar para criar uma configuração de credencial usando o ponto de extremidade de API /authoring/credentials.

Quando usar o ponto de extremidade de API /credentials when-to-use

Use este ponto de extremidade de API para criar uma configuração de credencial somente se houver um sistema de autenticação global entre o Adobe e a plataforma de destino, e o cliente do Experience Platform não precisar fornecer credenciais de autenticação para se conectar ao destino. Nesse caso, você deve criar uma configuração de credencial usando o ponto de extremidade da API /credentials.

Ao usar um sistema de autenticação global, você deve definir "authenticationRule":"PLATFORM_AUTHENTICATION" na configuração de entrega de destino, ao criar uma nova configuração de destino. Em seguida, você deve criar uma configuração de credenciais e passar a ID do objeto de credencial no parâmetro authenticationId na configuração de entrega de destino.

Introdução às operações de API de credenciais get-started

Antes de continuar, consulte o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas com êxito para a API, incluindo como obter a permissão de criação de destino e os cabeçalhos necessários.

Criar uma configuração de credenciais create

Você pode criar uma nova configuração de credenciais fazendo uma solicitação POST para o ponto de extremidade /authoring/credentials.

Formato da API

POST /authoring/credentials

As solicitações a seguir criam novas configurações de credencial, definidas pelos parâmetros fornecidos na carga.

Selecione cada guia abaixo para visualizar o conteúdo correspondente.

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"
   }
}

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"
   }
}

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"
   }
}

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"
   }
}

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"
   }
}

Manipulação de erros de API error-handling

Os endpoints da API do Destination SDK seguem os princípios gerais de mensagem de erro da API do Experience Platform. Consulte códigos de status da API e erros no cabeçalho da solicitação no guia de solução de problemas do Experience Platform.

Próximas etapas next-steps

Depois de ler este documento, agora você sabe quando usar o ponto de extremidade de credenciais e como definir uma configuração de credenciais usando o ponto de extremidade de API /authoring/credentials Leia como usar o Destination SDK para configurar seu destino para entender onde esta etapa se encaixa no processo de configuração do seu destino.