Este tutorial muestra cómo utilizar las llamadas de API para conectarse a sus datos de Adobe Experience Platform, crear un destino de marketing decorreo electrónico, crear un flujo de datos para el nuevo destino creado y activar los datos en el nuevo destino creado.
Este tutorial utiliza el destino de Adobe Campaign en todos los ejemplos, pero los pasos son idénticos para todos los destinos de marketing por correo electrónico.
Si prefiere utilizar la interfaz de usuario en el CDP en tiempo real de Adobe para conectar un destino y activar datos, consulte Conectar un destino y Activar perfiles y segmentos en los tutoriales de destino .
Esta guía requiere un conocimiento práctico de los siguientes componentes de Adobe Experience Platform:
Las siguientes secciones proporcionan información adicional que debe conocer para activar datos en destinos de marketing por correo electrónico en CDP en tiempo real.
Para completar los pasos de este tutorial, debe tener listas las siguientes credenciales, según el tipo de destinos a los que esté conectando y activando segmentos.
accessId
, secretKey
domain
, port
, username
, password
o ssh key
(según el método de conexión a la ubicación FTP)Este tutorial proporciona ejemplos de llamadas a API para mostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados requeridos y cargas de solicitud con el formato adecuado. También se proporciona el JSON de muestra devuelto en las respuestas de API. Para obtener información sobre las convenciones utilizadas en la documentación de las llamadas de API de muestra, consulte la sección sobre cómo leer llamadas de API de ejemplo en la guía de solución de problemas Experience Platform .
Para realizar llamadas a Platform API, primero debe completar el tutorial deautenticación. Al completar el tutorial de autenticación se proporcionan los valores para cada uno de los encabezados necesarios en todas las llamadas Experience Platform de API, como se muestra a continuación:
{ACCESS_TOKEN}
{API_KEY}
{IMS_ORG}
Los recursos de Experience Platform pueden aislarse en entornos limitados virtuales específicos. En las solicitudes a Platform las API, puede especificar el nombre y la ID del simulador para pruebas en el que se realizará la operación. Son parámetros opcionales.
{SANDBOX_NAME}
Para obtener más información sobre los entornos limitados de Experience Platform, consulte la documentación general delentorno limitado.
Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado de tipo de medio adicional:
application/json
Puede encontrar la documentación de referencia adjunta para todas las llamadas de API en este tutorial en Swagger. Consulte la documentación de la API de servicio de flujo en Adobe.io. Le recomendamos que utilice este tutorial y la página de documentación de Swagger en paralelo.
Como primer paso, debe decidir a qué destino de mercadotecnia de correo electrónico desea activar los datos. Para empezar, realice una llamada para solicitar una lista de los destinos disponibles a los que puede conectar y activar segmentos. Realice la siguiente solicitud de GET al punto final para devolver una lista de los destinos disponibles: connectionSpecs
Formato API
GET /connectionSpecs
Solicitud
curl --location --request GET 'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs' \
--header 'accept: application/json' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'
Respuesta
Una respuesta correcta contiene una lista de los destinos disponibles y sus identificadores únicos (id
). Almacene el valor del destino que va a usar, como será necesario en otros pasos. Por ejemplo, si desea conectar y enviar segmentos a Adobe Campaign, busque el siguiente fragmento en la respuesta:
{
"id": "0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
"name": "Adobe Campaign",
...
...
}
A continuación, debe conectarse a sus Experience Platform datos para poder exportar los datos de perfil y activarlos en el destino que prefiera. Se trata de dos subpasos que se describen a continuación.
Formato API
POST /connections
Solicitud
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Base connection to Experience Platform",
"description": "This call establishes the connection to Experience Platform data",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
}
}'
{CONNECTION_SPEC_ID}
:: Utilice el ID de especificación de conexión para el servicio de Perfil unificado - 8a9c3494-9708-43d7-ae3f-cda01e5030e1
.Respuesta
Una respuesta correcta contiene el identificador único (id
) de la conexión base. Almacene este valor como sea necesario en el paso siguiente para crear la conexión de origen.
{
"id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}
Formato API
POST /sourceConnections
Solicitud
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Connecting to Unified Profile Service",
"description": "Optional",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
},
"baseConnectionId": "{BASE_CONNECTION_ID}",
"data": {
"format": "CSV",
"schema": null
},
"params" : {}
}'
{BASE_CONNECTION_ID}
:: Utilice el Id obtenido en el paso anterior.{CONNECTION_SPEC_ID}
:: Utilice el ID de especificación de conexión para Unified Profile Service - 8a9c3494-9708-43d7-ae3f-cda01e5030e1
.Respuesta
Una respuesta correcta devuelve el identificador único (id
) de la conexión de origen recién creada a Unified Profile Service. Esto confirma que se ha conectado correctamente a los Experience Platform datos. Almacene este valor tal como se requiere en un paso posterior.
{
"id": "ed48ae9b-c774-4b6e-88ae-9bc7748b6e97"
}
En este paso, está configurando una conexión con el destino de mercadotecnia de correo electrónico deseado. Se trata de dos subpasos que se describen a continuación.
Formato API
POST /connections
Solicitud
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "S3 Connection for Adobe Campaign",
"description": "summer advertising campaign",
"connectionSpec": {
"id": "{_CONNECTION_SPEC_ID}",
"version": "1.0"
},
"auth": {
"specName": "{S3 or SFTP}",
"params": {
"accessId": "{ACCESS_ID}",
"secretKey": "{SECRET_KEY}"
}
}
}'
{CONNECTION_SPEC_ID}
:: Utilice el ID de especificación de conexión que obtuvo en el paso Obtener la lista de los destinosdisponibles.{S3 or SFTP}
:: rellene el tipo de conexión deseado para este destino. En el catálogo dedestino, desplácese hasta el destino que prefiera para ver si se admiten los tipos de conexión S3 o SFTP.{ACCESS_ID}
:: Su ID de acceso para la ubicación del almacenamiento Amazon S3.{SECRET_KEY}
:: La clave secreta para la ubicación del almacenamiento Amazon S3.Respuesta
Una respuesta correcta contiene el identificador único (id
) de la conexión base. Almacene este valor como sea necesario en el paso siguiente para crear una conexión de destinatario.
{
"id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}
Formato API
POST /targetConnections
Solicitud
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "TargetConnection for Adobe Campaign",
"description": "Connection to Adobe Campaign",
"baseConnectionId": "{BASE_CONNECTION_ID}",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
},
"data": {
"format": "json",
"schema": {
"id": "1.0",
"version": "1.0"
}
},
"params": {
"mode": "S3",
"bucketName": "{BUCKETNAME}",
"path": "{FILEPATH}",
"format": "CSV"
}
}'
{BASE_CONNECTION_ID}
:: Utilice el ID de conexión base que obtuvo en el paso anterior.{CONNECTION_SPEC_ID}
:: Utilice la especificación de conexión que obtuvo en el paso Obtener la lista de los destinosdisponibles.{BUCKETNAME}
:: Su bucket Amazon S3, donde CDP en tiempo real depositará la exportación de datos.{FILEPATH}
:: La ruta en el directorio de bucket de Amazon S3 donde CDP en tiempo real depositará la exportación de datos.Respuesta
Una respuesta correcta devuelve el identificador único (id
) de la conexión de destinatario recién creada al destino de marketing por correo electrónico. Almacene este valor tal como se requiere en pasos posteriores.
{
"id": "12ab90c7-519c-4291-bd20-d64186b62da8"
}
Con los ID obtenidos en los pasos anteriores, ahora puede crear un flujo de datos entre los datos Experience Platform y el destino en el que activará los datos. Considere este paso como la construcción de la canalización, a través de la cual los datos fluirán más adelante, entre Experience Platform y el destino deseado.
Para crear un flujo de datos, realice una solicitud de POST, como se muestra a continuación, mientras proporciona los valores que se mencionan a continuación dentro de la carga útil.
Realice la siguiente solicitud de POST para crear un flujo de datos.
Formato API
POST /flows
Solicitud
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Activate segments to Adobe Campaign",
"description": "This operation creates a dataflow which we will later use to activate segments to Adobe Campaign",
"flowSpec": {
"id": "{FLOW_SPEC_ID}",
"version": "1.0"
},
"sourceConnectionIds": [
"{SOURCE_CONNECTION_ID}"
],
"targetConnectionIds": [
"{TARGET_CONNECTION_ID}"
],
"transformations": [
{
"name": "GeneralTransform",
"params": {
"segmentSelectors": {
"selectors": []
},
"profileSelectors": {
"selectors": []
}
}
}
]
}
{FLOW_SPEC_ID}
:: Utilice el flujo para el destino de marketing por correo electrónico al que desea conectarse. Para obtener la especificación de flujo, realice una operación de GET en el flowspecs
extremo. Consulte la documentación de Swagger aquí: https://platform.adobe.io/data/foundation/flowservice/swagger#/Flow%20Specs%20API/getFlowSpecs. En la respuesta, busque upsTo
y copie el ID correspondiente del destino de marketing por correo electrónico al que desea conectarse. Por ejemplo, para Adobe Campaign, busque upsToCampaign
y copie el id
parámetro.{SOURCE_CONNECTION_ID}
:: Utilice el ID de conexión de origen obtenido en el paso Conectar con su Experience Platform.{TARGET_CONNECTION_ID}
:: Utilice el ID de conexión de destinatario obtenido en el paso Conectar con destinode marketing por correo electrónico.Respuesta
Una respuesta correcta devuelve el ID (id
) del flujo de datos recién creado y un etag
. Anote ambos valores. como lo hará en el paso siguiente, para activar segmentos.
{
"id": "8256cfb4-17e6-432c-a469-6aedafb16cd5",
"etag": "8256cfb4-17e6-432c-a469-6aedafb16cd5"
}
Después de crear todas las conexiones y el flujo de datos, ahora puede activar los datos de perfil en la plataforma de marketing por correo electrónico. En este paso, se selecciona qué segmentos y qué atributos de perfil se envían al destino y se pueden programar y enviar datos al destino.
Para activar segmentos en el nuevo destino, debe realizar una operación de PATCH JSON, similar a la que se muestra a continuación. Puede activar varios segmentos y atributos de perfil en una sola llamada. Para obtener más información sobre el PATCH JSON, consulte la especificación RFC.
Formato API
PATCH /flows
Solicitud
curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'If-Match: "{ETAG}"' \
--data-raw '[
{
"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {
"type": "PLATFORM_SEGMENT",
"value": {
"name": "Name of the segment that you are activating",
"description": "Description of the segment that you are activating",
"id": "{SEGMENT_ID}"
}
}
},
{
"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {
"type": "PLATFORM_SEGMENT",
"value": {
"name": "Name of the segment that you are activating",
"description": "Description of the segment that you are activating",
"id": "{SEGMENT_ID}"
}
}
},
{
"op": "add",
"path": "/transformations/0/params/profileSelectors/selectors/-",
"value": {
"type": "JSON_PATH",
"value": {
"operator": "EXISTS",
"path": "{PROFILE_ATTRIBUTE}"
}
}
}
]
{DATAFLOW_ID}
:: Utilice el flujo de datos obtenido en el paso anterior.{ETAG}
:: Utilice la etiqueta que obtuvo en el paso anterior.{SEGMENT_ID}
:: Proporcione el ID de segmento que desea exportar a este destino. Para recuperar los ID de segmento de los segmentos que desea activar, vaya a https://www.adobe.io/apis/experienceplatform/home/api-reference.html#/, seleccione la API de servicio de segmentación en el menú de navegación de la izquierda y busque la GET /segment/definitions
operación en Definiciones de segmentos.{PROFILE_ATTRIBUTE}
: Por ejemplo, "person.lastName"
Respuesta
Busque una respuesta 202 OK. No se devuelve ningún cuerpo de respuesta. Para validar que la solicitud era correcta, consulte el paso siguiente, Validar el flujo de datos.
Como último paso del tutorial, debe validar que los segmentos y atributos de perfil se hayan asignado correctamente al flujo de datos.
Para validar esto, realice la siguiente solicitud de GET:
Formato API
GET /flows
Solicitud
curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: prod' \
--header 'If-Match: "{ETAG}"'
{DATAFLOW_ID}
:: Utilice el flujo de datos del paso anterior.{ETAG}
:: Utilice la etiqueta del paso anterior.Respuesta
La respuesta devuelta debe incluir en el transformations
parámetro los segmentos y los atributos de perfil que ha enviado en el paso anterior. A continuación se muestra un parámetro transformations
de muestra en la respuesta:
"transformations": [
{
"name": "GeneralTransform",
"params": {
"profileSelectors": {
"selectors": []
},
"segmentSelectors": {
"selectors": [
{
"type": "PLATFORM_SEGMENT",
"value": {
"name": "Men over 50",
"description": "",
"id": "72ddd79b-6b0a-4e97-a8d2-112ccd81bd02"
}
}
]
}
}
}
],
Siguiendo este tutorial, ha conectado con éxito CDP en tiempo real a uno de los destinos de mercadotecnia de correo electrónico preferidos y ha configurado un flujo de datos para el destino correspondiente. Los datos salientes ahora se pueden utilizar en el destino para campañas por correo electrónico, publicidad de destino y muchos otros casos de uso. Consulte las páginas siguientes para obtener más información: