Flow Service se utiliza para recopilar y centralizar datos de clientes de diferentes fuentes dentro de Adobe Experience Platform. El servicio proporciona una interfaz de usuario y una API RESTful desde las que se pueden conectar todas las fuentes admitidas.
Este tutorial utiliza la variable Flow Service API para explorar los sistemas de éxito del cliente (CS).
Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:
Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente a un sistema CS mediante el Flow Service API.
Para explorar su sistema CS utilizando Platform API, debe poseer un ID de conexión base válido. Si todavía no tiene una conexión base para el sistema CS con el que desea trabajar, puede crear una a través de los siguientes tutoriales:
Este tutorial proporciona llamadas de API de ejemplo para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas de acceso, encabezados necesarios y cargas de solicitud con el formato correcto. 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 para las llamadas de API de ejemplo, consulte la sección sobre cómo leer llamadas de API de ejemplo en el Experience Platform guía de solución de problemas.
Para realizar llamadas a Platform API, primero debe completar la variable tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores para cada uno de los encabezados necesarios en todos los Experience Platform Llamadas de API, como se muestra a continuación:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Todos los recursos de Experience Platform, incluidas las pertenecientes a Flow Service, están aisladas para entornos limitados virtuales específicos. Todas las solicitudes a Platform Las API requieren un encabezado que especifique el nombre del simulador para pruebas en el que se realizará la operación:
{SANDBOX_NAME}
Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado de tipo de medio adicional:
application/json
Con la conexión base para su sistema CS, puede explorar las tablas de datos realizando solicitudes de GET. Utilice la siguiente llamada para encontrar la ruta de la tabla en la que desea inspeccionar o introducir Platform.
Formato de API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Parámetro | Descripción |
---|---|
{BASE_CONNECTION_ID} |
El ID de una conexión base CS. |
Solicitud
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/60a5c8b9-3c30-43ba-a5c8-b93c3093ba66/explore?objectType=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Respuesta
Una respuesta correcta devuelve una matriz de tablas de su sistema CS. Encuentre la tabla en la que desea traer Platform y tome nota de su path
, tal y como se le pedirá en el siguiente paso para inspeccionar su estructura.
[
{
"type": "table",
"name": "Accepted Event Relation",
"path": "AcceptedEventRelation",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Account",
"path": "Account",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Account Change Event",
"path": "AccountChangeEvent",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Account Clean Info",
"path": "AccountCleanInfo",
"canPreview": true,
"canFetchSchema": true
}
]
Para inspeccionar la estructura de una tabla desde el sistema CS, realice una solicitud de GET al especificar la ruta de una tabla como parámetro de consulta.
Formato de API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Parámetro | Descripción |
---|---|
{BASE_CONNECTION_ID} |
El ID de una conexión base CS. |
{TABLE_PATH} |
Ruta de una tabla. |
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/60a5c8b9-3c30-43ba-a5c8-b93c3093ba66/explore?objectType=table&object=test1.Mytable' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Respuesta
Una respuesta correcta devuelve la estructura de la tabla especificada. Los detalles sobre cada una de las columnas de la tabla se encuentran dentro de los elementos de la variable columns
matriz.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "Id",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Name",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Phone",
"type": "string",
"xdm": {
"type": "string"
}
},
]
}
}
Al seguir este tutorial, ha explorado su sistema CS y ha encontrado la ruta de la tabla en la que desea realizar la ingesta Platformy obtuvo información sobre su estructura. Puede utilizar esta información en el siguiente tutorial para recopilar datos de su sistema CS e introducirlos en Platform.