Teste seu destino baseado em arquivo com perfis de amostra

Visão geral overview

Esta página explica como usar o endpoint da API /testing/destinationInstance para testar se o destino baseado em arquivo está configurado corretamente e verificar a integridade dos fluxos de dados para o destino configurado.

Você pode fazer solicitações ao ponto de extremidade de teste com ou sem adicionar perfis de amostra à chamada. Se você não enviar nenhum perfil na solicitação, a API gerará um perfil de amostra automaticamente e o adicionará à solicitação.

Os perfis de amostra gerados automaticamente contêm dados genéricos. Se você quiser testar seu destino com dados de perfil personalizados e mais intuitivos, use a API de geração de perfil de exemplo para gerar um perfil de exemplo, personalize sua resposta e inclua-a na solicitação para o ponto de extremidade /testing/destinationInstance.

Introdução getting-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.

Pré-requisitos prerequisites

Antes de usar o ponto de extremidade /testing/destinationInstance, verifique se você atende às seguintes condições:

  • Você tem um destino baseado em arquivo existente criado por meio do Destination SDK e pode visualizá-lo em seu catálogo de destinos.

  • Você criou pelo menos um fluxo de ativação para o destino na interface do usuário do Experience Platform.

  • Para fazer a solicitação de API com êxito, é necessário ter a ID da instância de destino correspondente à instância de destino que você testará. Obtenha a ID da instância de destino que você deve usar na chamada da API, no URL, ao navegar por uma conexão com seu destino na interface do Platform.

    Imagem da interface do usuário mostrando como obter a ID da instância de destino da URL.

  • Opcional: se você deseja testar sua configuração de destino com um perfil de exemplo adicionado à chamada de API, use o ponto de extremidade /sample-profiles para gerar um perfil de exemplo com base no esquema de origem existente. Se você não fornecer um perfil de amostra, a API gerará um e o retornará na resposta.

Testar a configuração de destino sem adicionar perfis à chamada test-without-adding-profiles

Formato da API

POST /authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Solicitação

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
Parâmetros de caminho
Descrição
{DESTINATION_INSTANCE_ID}
A ID da instância de destino para a qual você está gerando perfis de amostra. Consulte a seção pré-requisitos para obter detalhes sobre como obter essa ID.

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 junto com a carga de resposta.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"john.smith@abc.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"crmid-P1A7l"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"string",
               "lastName":"string"
            }
         }
      }
   ]
}
Propriedade
Descrição
activations
Retorna a ID de público-alvo e a ID de execução de fluxo para cada público-alvo ativado. O número de entradas de ativação (e arquivos gerados associados) é igual ao número de públicos mapeados na instância de destino.

Exemplo: se você mapeou dois públicos-alvo para a instância de destino, a matriz activations conterá duas entradas. Cada público ativado corresponderá a um arquivo exportado.
results
Retorna a ID da instância de destino e as IDs de execução de fluxo que você pode usar para chamar a API de resultados, para testar ainda mais a integração.
inputProfiles
Retorna os perfis de amostra gerados automaticamente pela API.

Testar a configuração de destino com perfis adicionados à chamada test-with-added-profiles

Para testar seu destino com dados de perfil personalizados e mais intuitivos, você pode personalizar a resposta obtida do ponto de extremidade /sample-profiles com valores de sua escolha e incluir o perfil personalizado na solicitação para o ponto de extremidade /testing/destinationInstance.

Formato da API

POST  /testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Solicitação

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
 {
   "profiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}'
Parâmetro
Descrição
{DESTINATION_INSTANCE_ID}
A ID da instância de destino do destino que você está testando. A ID da instância de destino para a qual você está gerando perfis de amostra. Consulte a seção pré-requisitos para obter detalhes sobre como obter essa ID.
profiles
Matriz que pode incluir um ou vários perfis. Use o ponto de extremidade da API de perfil de amostra para gerar perfis a serem usados nesta chamada de API.

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 junto com a carga de resposta.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}
Propriedade
Descrição
activations
Retorna a ID de público-alvo e a ID de execução de fluxo para cada público-alvo ativado. O número de entradas de ativação (e arquivos gerados associados) é igual ao número de públicos mapeados na instância de destino.

Exemplo: se você mapeou dois públicos-alvo para a instância de destino, a matriz activations conterá duas entradas. Cada público ativado corresponderá a um arquivo exportado.
results
Retorna a ID da instância de destino e as IDs de execução de fluxo que você pode usar para chamar a API de resultados, para testar ainda mais a integração.
inputProfiles
Retorna os perfis de amostra personalizados passados na solicitação de API.

Manipulação de erros de API 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

Depois de ler este documento, agora você sabe como testar a configuração de destino baseada em arquivo.

Se você tiver recebido uma resposta de API válida, seu destino está funcionando corretamente. Se quiser ver informações mais detalhadas sobre o fluxo de ativação, você poderá usar a propriedade results da resposta a exibir resultados detalhados da ativação.

Se você estiver criando um destino público, agora pode enviar a configuração de destino para o Adobe para revisão.

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