DocumentaçãoExperience PlatformGuia de destinos

Recuperar uma configuração de credencial

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Administrador
  • Usuário
IMPORTANT
Ponto de extremidade de 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 recuperar 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

IMPORTANT
Na maioria dos casos, você não precisa usar o ponto de extremidade de API /credentials. Em vez disso, você pode configurar as informações de autenticação para o seu destino através dos parâmetros customerAuthenticationConfigurations do ponto de extremidade /destinations.
Leia a Configuração de autenticação do cliente para obter informações detalhadas sobre os tipos de autenticação com suporte.

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 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.

IMPORTANT
Todos os nomes e valores de parâmetros suportados pelo Destination SDK fazem distinção entre maiúsculas e 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, 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.

Recuperar uma configuração de credencial retrieve

Você pode recuperar uma configuração de credencial existente fazendo uma solicitação GET para o ponto de extremidade /authoring/credentials.

Formato da API

Use o formato de API a seguir para recuperar todas as configurações de credencial da sua conta.

GET /authoring/credentials

Use o formato de API a seguir para recuperar uma configuração de credencial específica, definida pelo parâmetro {INSTANCE_ID}.

GET /authoring/credentials/{INSTANCE_ID}

As duas solicitações a seguir recuperam todas as configurações de credenciais para sua Organização IMS ou uma configuração de credencial específica, dependendo se você passa o parâmetro INSTANCE_ID na solicitação.

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

Recuperar todas as configurações de credencial
accordion
Solicitação
code language-shell 
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}' \
accordion
Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com uma lista de configurações de credencial às quais você tem acesso, com base no IMS Org ID e no nome da sandbox que você usou. Um instanceId corresponde a uma configuração de credencial.

code language-json 
{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
},
{
   "instanceId":"a25bffa0-3127-4030-895d-1d1236bb3680",
   "createdDate":"2022-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2022-08-07T06:41:48.641943Z",
   "type":"basic",
   "name":"yourdestination",
   "s3Authentication":{
      "url":"string",
      "username":"string",
      "password":"string"
   }
}
Recuperar uma configuração de credencial específica
accordion
Solicitação
code language-shell 
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -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}'
table 0-row-2 1-row-2
Parâmetro Descrição
{INSTANCE_ID} A ID da configuração de credencial que você deseja recuperar.
accordion
Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração de credencial correspondente ao instanceId fornecido na solicitação.

code language-json 
{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}

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 como recuperar detalhes sobre as configurações de credencial usando o ponto de extremidade da 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.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6