Introdução
Visão geral overview
Esta página descreve como se autenticar e começar a usar o Adobe Experience Platform Destination SDK. Ele inclui instruções sobre como obter credenciais de autenticação de Adobe I/O, um nome de sandbox e a permissão de controle de acesso de criação de destino.
Terminologia terminology
Este guia usa conceitos específicos da plataforma, como organização e sandboxes. Consulte o glossário de Experience Platform para obter as definições desses termos. Consulte o glossário de Destination SDK para obter os termos relacionados diretamente a esta funcionalidade.
Obter as credenciais de autenticação necessárias obtain-authentication-credentials
O Destination SDK usa o gateway Adobe I/O para autenticação. Para fazer chamadas de API para endpoints Destination SDK, você deve fornecer determinados cabeçalhos em suas chamadas de API. Trabalhe com a equipe do Adobe Exchange para configurar a autenticação para você no Adobe Developer Console.
Para fazer chamadas com êxito para pontos de extremidade de API Destination SDK, siga o tutorial de autenticação Experience Platform. Inicie o tutorial da etapa "Gerar uma chave de API, ID da organização e segredo do cliente". A equipe do Adobe Exchange irá lidar com as etapas anteriores para você. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários nas chamadas de API de Destination SDK, conforme mostrado abaixo:
x-api-key: {API_KEY}
, também conhecido como ID do clientex-gw-ims-org-id: {ORG_ID}
, também conhecido como ID da organizaçãoAuthorization: Bearer {ACCESS_TOKEN}
. O token de acesso tem um tempo de expiração de 24 horas, expresso em milissegundos, portanto, você terá que atualizá-lo. Para atualizar o token de acesso, repita as etapas descritas no tutorial de autenticação.
Propriedade de destino e sandboxes destination-ownership
Todos os recursos no Experience Platform são isolados em sandboxes virtuais específicas. As solicitações para Destination SDK exigem cabeçalhos que especifiquem o nome da sandbox em que a operação ocorre:
x-sandbox-name: {SANDBOX_NAME}
A equipe do Adobe Exchange fornece o nome da sandbox, que você precisa usar em chamadas para os endpoints da API do Destination SDK.
Controle de acesso baseado em função (RBAC) rbac
Para usar os pontos de extremidade da API de Destination SDK descritos na documentação de referência, você precisa da permissão de controle de acesso Criação de Destino. Trabalhe com a equipe do Adobe Exchange para obter esta permissão atribuída a você no Adobe Admin Console.
Para obter mais informações, leia os seguintes documentos sobre o Controle de acesso a Experience Platform:
Considerações adicionais additional-considerations
- Para destinos públicos/de produção, todas as alterações feitas nas configurações de destino, seja para criar ou editar uma configuração de destino, precisam ser revisadas e aprovadas pelo Adobe. As alterações são refletidas nos destinos somente após a revisão ser concluída. Isso não se aplica a destinos privados que só estão disponíveis para você.
- Somente os usuários que pertencem à mesma organização e têm acesso à sandbox podem editar a configuração de destino.
Próximas etapas next-steps
Seguindo as etapas deste artigo, você obteve credenciais de autenticação para o Adobe I/O, um nome de sandbox e a permissão de controle de acesso de criação de destino. Em seguida, você pode configurar um destino usando o Destination SDK.
-
Leia os seguintes guias de configuração, dependendo do tipo de destino:
-
Para todas as operações, consulte a documentação da API de criação de destino.
-
Use a coleção de Postman da API de Criação de Destino para configurar seu destino usando os pontos de extremidade da API Destination SDK. Para começar a usar o Postman, consulte as etapas para importar ambientes e coleções e o guia de vídeo para criar o ambiente do Postman.