[Beta]{class="badge informative"}
Crear una conexión de origen y un flujo de datos para SAP Commerce uso de la API de Flow Service
El siguiente tutorial le guiará para crear una SAP Commerce conexión de origen y un flujo de datos para traer SAP Facturación de suscripción contactos y datos de clientes a Adobe Experience Platform mediante Flow Service API.
Introducción
Esta guía requiere una comprensión práctica de los siguientes componentes de Experience Platform:
- Fuentes: Experience Platform permite la ingesta de datos desde varias fuentes y, al mismo tiempo, le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
- Zonas protegidas: El Experience Platform proporciona entornos limitados virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.
Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente a SAP Commerce uso del Flow Service API.
Recopilar credenciales necesarias
Para poder conectarse SAP Commerce para acceder a Experience Platform, debe proporcionar valores para las siguientes propiedades de conexión:
clientId
clientId
desde la clave de servicio.clientSecret
clientSecret
desde la clave de servicio.tokenEndpoint
url
desde la clave de servicio, será similar a https://subscriptionbilling.authentication.eu10.hana.ondemand.com
.region
url
y tiene un valor similar al siguiente eu10
o us10
. Por ejemplo, si la variable url
es https://subscriptionbilling.authentication.eu10.hana.ondemand.com
, entonces necesitará eu10
.Para obtener más información, consulte la SAP Commerce documentación.
Connect SAP Commerce a Platform mediante el Flow Service API
A continuación se describen los pasos que debe seguir para autenticar su SAP Commerce origen, crear una conexión de origen y crear un flujo de datos para llevar los datos de cuentas y contactos a Experience Platform.
Cree una conexión base base-connection
Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.
Para crear un ID de conexión base, realice una solicitud de POST al /connections
extremo al proporcionar su SAP Commerce credenciales de autenticación como parte del cuerpo de la solicitud.
Formato de API
POST /connections
Solicitud
La siguiente solicitud crea una conexión base para SAP Commerce:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SAP Commerce base connection",
"description": "Authenticated base connection for SAP Commerce",
"connectionSpec": {
"id": "d8ee38de-7ae9-4058-9610-c79ce75f8e92",
"version": "1.0"
},
"auth": {
"specName": "OAuth2 Client Credential",
"params": {
"region": "{REGION}",
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}"
"tokenEndpoint": "{TOKEN_ENDPOINT}"
}
}
}'
name
description
connectionSpec.id
auth.specName
auth.params.region
url
y tiene un valor similar al siguiente eu10
o us10
. Por ejemplo, si la variable url
es https://subscriptionbilling.authentication.eu10.hana.ondemand.com
usted necesitará eu10
.auth.params.clientId
clientId
desde la clave de servicio.auth.params.clientSecret
clientSecret
desde la clave de servicio.auth.params.tokenEndpoint
url
desde la clave de servicio, será similar a https://subscriptionbilling.authentication.eu10.hana.ondemand.com
.Respuesta
Una respuesta correcta devuelve la conexión base recién creada, incluido su identificador de conexión único (id
). Este ID es necesario para explorar la estructura de archivos y el contenido de origen en el siguiente paso.
{
"id": "5f6d6022-3f64-400c-ba01-d4010de2d8ff",
"etag": "\"f8018de1-0000-0200-0000-6482d7210000\""
}
Explorar su origen explore
Una vez que tenga el ID de conexión base, ahora puede explorar el contenido y la estructura de los datos de origen realizando una solicitud de GET a /connections
al proporcionar su ID de conexión base como parámetro de consulta.
Formato de API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}
Al realizar solicitudes para explorar la estructura de archivos y el contenido de origen, debe incluir los parámetros de GET que se enumeran en la tabla siguiente:
{BASE_CONNECTION_ID}
objectType=rest
rest
.{OBJECT}
json
.fileType=json
json
es el único tipo de archivo compatible.{PREVIEW}
{SOURCE_PARAMS}
Define parámetros para el archivo de origen que desea llevar a Platform. Para recuperar el tipo de formato aceptado para {SOURCE_PARAMS}
, debe codificar toda la cadena en base64.
SAP Commerce admite varias API. Según el tipo de objeto que esté aprovechando, pase uno de los siguientes:
customers
contacts
El SAP Commerce La fuente de admite varias API. Según el tipo de objeto que utilice, la solicitud que se va a enviar es la siguiente:
accordion | ||
---|---|---|
Solicitud | ||
Para SAP Commerce La API de cliente tiene el valor para
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve una estructura JSON como la siguiente:
|
accordion | ||
---|---|---|
Solicitud | ||
Para SAP Commerce El valor de la API Contactos es
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve una estructura JSON como la siguiente:
|
Crear una conexión de origen source-connection
Puede crear una conexión de origen realizando una solicitud de POST a /sourceConnections
punto final del Flow Service API. Una conexión de origen consta de un identificador de conexión, una ruta de acceso al archivo de datos de origen y un identificador de especificación de conexión.
Formato de API
POST /sourceConnections
Según el tipo de objeto que esté aprovechando, seleccione una de las pestañas siguientes:
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Solicitud | ||||||||||||||||||||
La siguiente solicitud crea una conexión de origen para SAP Commerce datos de clientes:
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve el identificador único (
|
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Solicitud | ||||||||||||||||||||
La siguiente solicitud crea una conexión de origen para SAP Commerce datos de contactos:
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve el identificador único (
|
Creación de un esquema XDM de destino target-schema
Para que los datos de origen se utilicen en Platform, se debe crear un esquema de destino para estructurar los datos de origen según sus necesidades. A continuación, el esquema de destino se utiliza para crear un conjunto de datos de Platform en el que se incluyen los datos de origen.
Se puede crear un esquema XDM de destino realizando una solicitud de POST a la variable API de Registro de esquemas.
Para ver los pasos detallados sobre cómo crear un esquema XDM de destino, consulte el tutorial sobre creación de un esquema con la API.
Crear un conjunto de datos de destinatario target-dataset
Se puede crear un conjunto de datos de destino realizando una solicitud de POST al API del servicio de catálogo, proporcionando el ID del esquema de destinatario dentro de la carga útil.
Para ver los pasos detallados sobre cómo crear un conjunto de datos de destinatario, consulte el tutorial sobre creación de un conjunto de datos mediante la API.
Creación de una conexión de destino target-connection
Una conexión de destino representa la conexión con el destino en el que se van a almacenar los datos introducidos. Para crear una conexión de destino, debe proporcionar el ID de especificación de conexión fija que corresponda al lago de datos. Este ID es: c604ff05-7f1a-43c0-8e18-33bf874cb11c
.
Ahora tiene los identificadores únicos de un esquema de destino, un conjunto de datos de destino y el ID de especificación de conexión al lago de datos. Con estos identificadores, puede crear una conexión de destino con el Flow Service API para especificar el conjunto de datos que contendrá los datos de origen entrantes.
Formato de API
POST /targetConnections
Solicitud
La siguiente solicitud crea una conexión de destino para SAP Commerce:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SAP Commerce Target Connection Generic Rest",
"description": "SAP Commerce Target Connection Generic Rest",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "parquet_xdm",
"schema": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/325fd5394ba421246b05c0a3c2cd5efeec2131058a63d473",
"version": "1.2"
}
},
"params": {
"dataSetId": "645923cd7aeeea1c06c5e92e"
}
}'
name
description
connectionSpec.id
6b137bf6-d2a0-48c8-914b-d50f4942eb85
.data.format
params.dataSetId
Respuesta
Una respuesta correcta devuelve el identificador único ( ) de la nueva conexión de destinoid
). Este ID es necesario en pasos posteriores.
{
"id": "5b72a4b6-2fb8-4ca7-8ad8-4114a3063c5c",
"etag": "\"db00c6dc-0000-0200-0000-6482d8280000\""
}
Creación de una asignación mapping
Para que los datos de origen se incorporen en un conjunto de datos de destino, primero deben asignarse al esquema de destino al que se adhiere el conjunto de datos de destino. Esto se logra realizando una solicitud de POST a Data Prep API con asignaciones de datos definidas dentro de la carga útil de la solicitud.
Formato de API
POST /conversion/mappingSets
accordion | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Solicitud | ||||||||||||||
La siguiente solicitud crea una asignación para SAP Commerce Datos de API de clientes
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve detalles de la asignación recién creada, incluido su identificador único (
|
accordion | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Solicitud | ||||||||||||||
La siguiente solicitud crea una asignación para SAP Commerce Datos de API de contactos
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve detalles de la asignación recién creada, incluido su identificador único (
|
Creación de un flujo flow
El último paso para obtener datos de SAP Commerce a Platform es crear un flujo de datos. Por ahora, tiene preparados los siguientes valores obligatorios:
Un flujo de datos es responsable de programar y recopilar datos de una fuente. Puede crear un flujo de datos realizando una solicitud de POST mientras proporciona los valores mencionados anteriormente dentro de la carga útil.
Formato de API
POST /flows
Solicitud
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SAP Commerce Connector Description Flow Generic Rest",
"description": "SAP Commerce Connector Description Flow Generic Rest",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"2ef2e831-f4f1-4363-a0f7-08b4ea347164"
],
"targetConnectionIds": [
"5b72a4b6-2fb8-4ca7-8ad8-4114a3063c5c"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "ddf0592bcc9d4ac391803f15f2429f87",
"mappingVersion": "0"
}
}
],
"scheduleParams": {
"startTime": "1625040887",
"frequency": "once",
}
}'
name
description
flowSpec.id
6499120c-0b15-42dc-936e-847ea3c24d72
.flowSpec.version
1.0
.sourceConnectionIds
targetConnectionIds
transformations
transformations.name
transformations.params.mappingId
transformations.params.mappingVersion
0
.scheduleParams.startTime
scheduleParams.frequency
scheduleParams.interval
Respuesta
Una respuesta correcta devuelve el ID (id
) del flujo de datos recién creado. Puede utilizar este ID para monitorizar, actualizar o eliminar el flujo de datos.
{
"id": "fcd16140-81b4-422a-8f9a-eaa92796c4f4",
"etag": "\"9200a171-0000-0200-0000-6368c1da0000\""
}
Apéndice
En la siguiente sección se proporciona información sobre los pasos que puede seguir para monitorizar, actualizar y eliminar el flujo de datos.
Monitorización del flujo de datos
Una vez creado el flujo de datos, puede monitorizar los datos que se están introduciendo a través de él para ver información sobre las ejecuciones de flujo, el estado de finalización y los errores. Para ver ejemplos completos de la API, lea la guía de monitorización de los flujos de datos de origen mediante la API.
Actualizar el flujo de datos
Actualice los detalles del flujo de datos, como su nombre y descripción, así como su programación de ejecución y los conjuntos de asignaciones asociados realizando una solicitud del PATCH a /flows
punto final de Flow Service API, mientras proporciona el ID del flujo de datos. Al realizar una solicitud de PATCH, debe proporcionar la variable única del flujo de datos etag
en el If-Match
encabezado. Para ver ejemplos completos de la API, lea la guía de actualización de flujos de datos de origen mediante la API.
Actualice su cuenta
Actualice el nombre, la descripción y las credenciales de la cuenta de origen realizando una solicitud al PATCH de Flow Service al proporcionar su ID de conexión base como parámetro de consulta. Al realizar una solicitud de PATCH, debe proporcionar la cuenta de origen única etag
en el If-Match
encabezado. Para ver ejemplos completos de la API, lea la guía de actualización de la cuenta de origen mediante la API.
Eliminar el flujo de datos
Elimine el flujo de datos realizando una solicitud de DELETE a Flow Service API al proporcionar el ID del flujo de datos que desea eliminar como parte del parámetro de consulta. Para ver ejemplos completos de la API, lea la guía de eliminación de flujos de datos mediante la API.
Eliminar su cuenta
Elimine la cuenta realizando una solicitud de DELETE a Flow Service al proporcionar el ID de conexión base de la cuenta que desea eliminar. Para ver ejemplos completos de la API, lea la guía de Eliminar la cuenta de origen mediante la API.