Validar campos de cliente modelados
Visão geral overview
O ponto de extremidade /authoring/testing/template/render
ajuda a visualizar como seriam os campos de dados do cliente modelados definidos na configuração de destino.
O endpoint gera valores aleatórios para os campos de dados do cliente e os retorna na resposta. Isso ajuda a validar a estrutura semântica dos campos de dados do cliente, como nomes de buckets ou caminhos de pastas.
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 /template/render
, 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.
-
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.
Renderizar campos de cliente modelados render-customer-fields
Formato da API
POST /authoring/testing/template/render/destination
Para ilustrar o comportamento desse endpoint de API, vamos considerar um destino baseado em arquivo com a seguinte configuração de campos de dados do cliente:
"fileBasedS3Destination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
Solicitação
A solicitação abaixo chama o ponto de extremidade /authoring/testing/template/render
, que retorna uma resposta com valores gerados aleatoriamente para os dois campos de dados do cliente mencionados acima.
curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/template/render/destination' \
-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 '
{
"destinationId": "{DESTINATION_CONFIGURATION_ID}",
"templates": {
"bucket": "{{customerData.bucket}}",
"path": "{{customerData.bucket}}/{{customerData.path}}"
}
}'
destinationId
templates
Resposta
Uma resposta bem-sucedida retorna um status HTTP 200 OK
, e o corpo inclui valores gerados aleatoriamente para seus campos de modelo.
Essa resposta pode ajudar a validar a estrutura correta dos campos de dados do cliente, como nomes de buckets ou caminhos de pastas.
{
"results": {
"bucket": "hfWpE-bucket",
"path": "hfWpE-bucket/ceC"
}
}
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 next-steps
Depois de ler este documento, agora você sabe como validar a configuração do campo de dados do cliente definida em seu servidor de destino.