Validar campos de cliente con plantilla
Información general overview
El /authoring/testing/template/render
El punto de conexión le ayuda a visualizar cómo se personalizan las plantillas campos de datos del cliente definido en la configuración de destino tendría el siguiente aspecto:.
El extremo genera valores aleatorios para los campos de datos del cliente y los devuelve en la respuesta. Esto le ayuda a validar la estructura semántica de los campos de datos del cliente, como los nombres de los bloques o las rutas de carpetas.
Primeros pasos getting-started
Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API, incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.
Requisitos previos prerequisites
Antes de usar el /template/render
extremo, asegúrese de cumplir las siguientes condiciones:
-
Tiene un destino basado en archivos existente creado mediante el Destination SDK y puede verlo en su catálogo de destinos.
-
Para realizar correctamente la solicitud de API, necesita el ID de instancia de destino correspondiente a la instancia de destino que va a probar. Obtenga el ID de instancia de destino que debe utilizar en la llamada a la API, desde la dirección URL, al examinar una conexión con su destino en la interfaz de usuario de Platform.
Procesar campos de cliente con plantillas render-customer-fields
Formato de API
POST /authoring/testing/template/render/destination
Para ilustrar el comportamiento de este extremo de API, consideremos un destino basado en archivos con la siguiente configuración de campos de datos del cliente:
"fileBasedS3Destination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
Solicitud
La solicitud siguiente llama a /authoring/testing/template/render
extremo, que devuelve una respuesta con valores generados aleatoriamente para los dos campos de datos del cliente mencionados anteriormente.
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
Respuesta
Una respuesta correcta devuelve un HTTP 200 OK
estado y el cuerpo incluye valores generados aleatoriamente para los campos con plantilla.
Esta respuesta puede ayudarle a validar la estructura correcta de los campos de datos del cliente, como los nombres de los bloques o las rutas de carpetas.
{
"results": {
"bucket": "hfWpE-bucket",
"path": "hfWpE-bucket/ceC"
}
}
Administración de errores de API api-error-handling
Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Platform.
Pasos siguientes next-steps
Después de leer este documento, ahora sabe cómo validar la configuración del campo de datos del cliente definida en su servidor de destino.