Documentação Experience Platform Guia de destinos

Criar uma configuração de credencial

Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:
Destinations

Criado para:

Admin
User

IMPORTANT

Ponto de acesso da API: platform.adobe.io/data/core/activation/authoring/credentials

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 /authoring/credentials Endpoint da API.

Quando usar a variável `/credentials` Endpoint da API when-to-use

IMPORTANT

Na maioria dos casos, você não necessidade de usar o /credentials Endpoint da API. Em vez disso, você poderá configurar as informações de autenticação para seu destino por meio da customerAuthenticationConfigurations parâmetros do /destinations terminal.

Ler Configuração de autenticação do cliente para obter informações detalhadas sobre os tipos de autenticação compatíveis.

Use esse endpoint de API para criar uma configuração de credencial somente se houver um sistema de autenticação global entre o Adobe e sua plataforma de destino e o Platform O cliente não precisa fornecer credenciais de autenticação para se conectar ao seu destino. Nesse caso, você deve criar uma configuração de credencial usando o /credentials Endpoint da API.

Ao usar um sistema de autenticação global, você deve definir "authenticationRule":"PLATFORM_AUTHENTICATION" no entrega de destino configuração, quando criação de uma nova configuração de destino.

IMPORTANT

Todos os nomes e valores de parâmetros compatíveis com o Destination SDK são diferencia maiúsculas de minúsculas. Para evitar erros de diferenciação entre maiúsculas e minúsculas, use os nomes e valores dos parâmetros exatamente como mostrado na documentação.

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

Antes de continuar, reveja 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 POST solicitação à /authoring/credentials terminal.

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.

Básico

Criar uma configuração básica de credencial

accordion

Solicitação

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	Descrição
`url`	String	URL do provedor de autorização
`username`	String	Nome de usuário para logon na configuração de credenciais
`password`	String	Senha de logon da configuração de credenciais

accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes da configuração de credenciais recém-criadas.

Amazon S3

Criar um Amazon S3 configuração de credencial

accordion

Solicitação

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	Descrição
`accessId`	String	Amazon S3 ID de acesso
`secretKey`	String	Amazon S3 chave secreta

accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes da configuração de credenciais recém-criadas.

SSH

Criar uma configuração de credencial SSH

accordion

Solicitação

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	Descrição
`username`	String	Nome de usuário para logon na configuração de credenciais
`sshKey`	String	Chave SSH para SFTP com autenticação SSH

accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes da configuração de credenciais recém-criadas.

Armazenamento Azure Data Lake

Criar um Azure Data Lake Storage configuração de credencial

accordion

Solicitação

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	Descrição
`url`	String	URL do provedor de autorização
`tenant`	String	Locatário do Armazenamento Azure Data Lake
`servicePrincipalId`	String	ID da Entidade de Serviço do Azure para Armazenamento do Azure Data Lake
`servicePrincipalKey`	String	Chave da Entidade de Serviço do Azure para Armazenamento do Azure Data Lake

accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes da configuração de credenciais recém-criadas.

Armazenamento Azure Blob

Criar um Azure Blob Storage configuração de credencial

accordion

Solicitação

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	Descrição
`connectionString`	String	Azure Blob Storage cadeia de conexão

accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes da configuração de credenciais recém-criadas.

Manipulação de erros de API error-handling

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

Próximas etapas next-steps

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

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6

Criar uma configuração de credencial

Quando usar a variável /credentials Endpoint da API when-to-use

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

Criar uma configuração de credenciais create

Manipulação de erros de API error-handling

Próximas etapas next-steps

Quando usar a variável `/credentials` Endpoint da API when-to-use