Flow Service se utiliza para recopilar y centralizar datos de clientes de varias fuentes diferentes 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 de datos admitidas.
Este tutorial utiliza el Flow Service API para explorar aplicaciones de protocolos.
Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:
Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente a una aplicación de protocolos utilizando Flow Service API.
Para explorar el sistema de protocolos utilizando Platform Las API deben tener un ID de conexión base válido. Si todavía no dispone de una conexión base para el sistema de protocolos con el que desea trabajar, puede crearla mediante el siguiente tutorial:
Este tutorial proporciona llamadas de API de ejemplo para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados obligatorios 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 de 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 el tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores para cada uno de los encabezados necesarios en todas las Experience Platform Llamadas de API, como se muestra a continuación:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Todos los recursos de Experience Platform, incluidos los pertenecientes a Flow Service, están aisladas para zonas protegidas virtuales específicas. Todas las solicitudes a Platform Las API requieren un encabezado que especifique el nombre de la zona protegida en la 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 medios adicional:
application/json
Con el id. de conexión para la aplicación de protocolos, puede explorar las tablas de datos realizando solicitudes de GET. Utilice la siguiente llamada para encontrar la ruta de la tabla que desea inspeccionar o introducir en Platform.
Formato de API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Parámetro | Descripción |
---|---|
{BASE_CONNECTION_ID} |
Id. de una conexión base de protocolo. |
Solicitud
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/a5c6b647-e784-4b58-86b6-47e784ab580b/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 desde la aplicación de protocolos. Encuentre la tabla que desea introducir en Platform y tome nota de su path
, ya que es necesario proporcionarla en el siguiente paso para inspeccionar su estructura.
[
{
"type": "table",
"name": "Categories",
"path": "Categories",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "CustomerDemographics",
"path": "CustomerDemographics",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Customers",
"path": "Customers",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Orders",
"path": "Orders",
"canPreview": true,
"canFetchSchema": true
}
]
Para inspeccionar la estructura de una tabla desde la aplicación de protocolos, realice una solicitud de GET mientras especifica 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} |
Id. de conexión de la aplicación de protocolos. |
{TABLE_PATH} |
Ruta de una tabla dentro de la aplicación de protocolos. |
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/a5c6b647-e784-4b58-86b6-47e784ab580b/explore?objectType=table&object=Orders' \
-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": "OrderID",
"type": "integer",
"xdm": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
{
"name": "CustomerID",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "EmployeeID",
"type": "integer",
"xdm": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
{
"name": "OrderDate",
"type": "string",
"meta:xdmType": "date-time",
"xdm": {
"type": "string",
"format": "date-time"
}
},
]
}
}
Al seguir este tutorial, ha explorado la aplicación de protocolos, ha encontrado la ruta de la tabla que desea introducir en Platformy obtuvo información sobre su estructura. Puede utilizar esta información en el siguiente tutorial para lo siguiente recopilar datos de la aplicación de protocolos e introducirlos en Platform.