Recuperar uma configuração de credencial

Última atualização em 2023-10-31
  • Tópicos
  • Destinations
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader
IMPORTANTE

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 recuperar uma configuração de credencial usando o /authoring/credentials Endpoint da API.

Quando usar a variável /credentials Endpoint da API

IMPORTANTE

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.

IMPORTANTE

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

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.

Recuperar uma configuração de credencial

Você pode recuperar um existente configuração de credencial fazendo um GET solicitação à /authoring/credentials terminal.

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 {INSTANCE_ID} parâmetro.

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 a INSTANCE_ID parâmetro na solicitação.

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

 Solicitação
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}' \
 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 o nome da sandbox que você usou. Um instanceId corresponde a uma configuração de credencial.

{
   "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"
   }
}
 Solicitação
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}'
Parâmetro Descrição
{INSTANCE_ID} A ID da configuração de credencial que você deseja recuperar.
 Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração de credencial correspondentes ao instanceId informações fornecidas no pedido.

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

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

Depois de ler este documento, agora você sabe como recuperar detalhes sobre as configurações de credencial usando o /authoring/credentials Endpoint da API. Ler como usar o Destination SDK para configurar seu destino para entender onde essa etapa se encaixa no processo de configuração do destino.

Nesta página