Crear borradores de las entidades de Flow Service mediante la API
Puede usar el parámetro de consulta mode=draft
en la Flow Service API para establecer las entidades de Flow Service, como las conexiones base, las conexiones de origen, las conexiones de destino y los flujos de datos, a un estado de borrador.
Los borradores se pueden actualizar posteriormente con información nueva y, a continuación, publicar una vez que estén listos, utilizando el parámetro de consulta op=publish
.
Este tutorial proporciona pasos sobre cómo establecer las entidades de Flow Service en un estado de borrador y le permite pausar y guardar los flujos de trabajo para completarlos más adelante.
Introducción
Este tutorial requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:
- Fuentes: El Experience Platform permite la ingesta de datos de varias fuentes, al tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
- Zonas protegidas: El Experience Platform proporciona zonas protegidas virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.
Uso de API de Platform
Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía sobre introducción a las API de Platform.
Compruebe la compatibilidad con el modo de borrador
También debe comprobar si el ID de especificación de conexión y el ID de especificación de flujo correspondiente del origen que está utilizando están habilitados para el modo borrador.
accordion | ||
---|---|---|
Solicitud | ||
La siguiente solicitud recupera la información de especificación de conexión para Azure File Storage:
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve la información de especificación de conexión del origen. Para comprobar si el modo de borrador es compatible con el origen, compruebe que
|
accordion | ||
---|---|---|
Solicitud | ||
La siguiente solicitud recupera los detalles de especificación de flujo para una fuente de almacenamiento en la nube:
|
accordion | ||
---|---|---|
Respuesta | ||
Una respuesta correcta devuelve la información de especificación de flujo del origen. Para comprobar si el modo de borrador es compatible con el origen, compruebe que
|
Crear una conexión base de borrador create-a-draft-base-connection
Para crear una conexión base de borrador, realice una solicitud de POST al extremo /connections
de la API Flow Service y proporcione mode=draft
como parámetro de consulta.
Formato de API
POST /connections?mode=draft
mode
mode
en draft
.Solicitud
La siguiente solicitud crea una conexión base de borrador para el origen Azure File Storage:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Base Connection",
"description": "Azure File Storage base connection for ACME data (DRAFT)",
"auth": {
"specName": "Basic Authentication",
"params": {
"host": "{HOST}",
"userId": "{USER_ID}",
"password": "{PASSWORD}"
}
},
"connectionSpec": {
"id": "be5ec48c-5b78-49d5-b8fa-7c89ec4569b8",
"version": "1.0"
}
}'
Respuesta
Una respuesta correcta devuelve el ID de conexión base y la etiqueta correspondiente para la conexión base de borrador. Puede utilizar este ID más adelante para actualizar y publicar la conexión base.
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Publish su conexión base de borrador publish-your-draft-base-connection
Una vez que el borrador esté listo para publicarse, realice una solicitud de POST al extremo /connections
y proporcione el identificador de la conexión base de borrador que desee publicar, así como una operación de acción para la publicación.
Formato de API
POST /connections/{BASE_CONNECTION_ID}/action?op=publish
op
op
en publish
.Solicitud
La siguiente solicitud publica el borrador de conexión base para Azure File Storage que se creó en un paso anterior.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections/f9377f50-607a-4818-b77f-50607a181860/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-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 el ID y la etiqueta correspondiente para la conexión base publicada.
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Crear una conexión de origen de borrador create-a-draft-source-connection
Para crear una conexión de origen de borrador, realice una solicitud de POST al extremo /sourceConnections
de la API Flow Service y proporcione mode=draft
como parámetro de consulta.
Formato de API
POST /sourceConnections?mode=draft
mode
mode
en draft
.Solicitud
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Source Connection",
"description: "Azure File Storage source connection for ACME data (DRAFT)",
"baseConnectionId": "f9377f50-607a-4818-b77f-50607a181860",
"data": {
"format": "delimited",
},
"params": {
"path": "/acme/summerCampaign/account.csv",
"type": "file"
},
"connectionSpec": {
"id": "be5ec48c-5b78-49d5-b8fa-7c89ec4569b8",
"version": "1.0"
}
}'
Respuesta
Una respuesta correcta devuelve el ID de conexión de origen y la etiqueta correspondiente para la conexión de origen de borrador. Puede utilizar este ID más adelante para actualizar y publicar la conexión de origen.
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
Publish su conexión de origen de borrador publish-your-draft-source-connection
Una vez que el borrador esté listo para publicarse, realice una solicitud de POST al extremo /sourceConnections
y proporcione el identificador de la conexión de origen de borrador que desee publicar, así como una operación de acción para la publicación.
Formato de API
POST /sourceConnections/{SOURCE_CONNECTION_ID}/action?op=publish
op
op
en publish
.Solicitud
La siguiente solicitud publica la conexión de origen de borrador para Azure File Storage que se creó en un paso anterior.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections/26b53912-1005-49f0-b539-12100559f0e2/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-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 el ID y la etiqueta correspondiente para la conexión de origen publicada.
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
Crear una conexión de destino de borrador create-a-draft-target-connection
Para crear una conexión de destino de borrador, realice una solicitud de POST al extremo /targetConnections
de la API Flow Service y proporcione mode=draft
como parámetro de consulta.
Formato de API
POST /targetConnections?mode=draft
mode
mode
en draft
.Solicitud
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Target Connection",
"description": "Azure File Storage target connection ACME data (DRAFT)",
"data": {
"schema": {
"id": "{SCHEMA_ID}",
"version": "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "{DATASET_ID}"
},
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}'
Respuesta
Una respuesta correcta devuelve el ID de conexión de destino y la etiqueta correspondiente para el borrador de conexión de destino. Puede utilizar este ID más adelante para actualizar y publicar la conexión de destino.
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
Publish su conexión de destino de borrador publish-your-draft-target-connection
Una vez que el borrador esté listo para publicarse, realice una solicitud de POST al extremo /targetConnections
y proporcione el identificador de la conexión de destino de borrador que desee publicar, así como una operación de acción para la publicación.
Formato de API
POST /targetConnections/{TARGET_CONNECTION_ID}/action?op=publish
op
op
en publish
.Solicitud
La siguiente solicitud publica el borrador de conexión de destino para Azure File Storage que se creó en un paso anterior.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections/dbc5c132-bc2a-4625-85c1-32bc2a262558/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-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 el ID y la etiqueta correspondiente para la conexión de destino publicada.
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
Crear un flujo de datos de borrador create-a-draft-dataflow
Para establecer un flujo de datos como borrador, realice una solicitud de POST al extremo /flows
al agregar mode=draft
como parámetro de consulta. Esto le permite crear un flujo de datos y guardarlo como borrador.
Formato de API
POST /flows?mode=draft
mode
mode
en draft
.Solicitud
La siguiente solicitud crea un flujo de datos de borrador.
'https://platform.adobe.io/data/foundation/flowservice/flows?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Dataflow",
"description": "Azure File Storage dataflow for ACME data (DRAFT)",
"sourceConnectionIds": [
"26b53912-1005-49f0-b539-12100559f0e2"
],
"targetConnectionIds": [
"dbc5c132-bc2a-4625-85c1-32bc2a262558"
],
"flowSpec": {
"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"version": "1.0"
}
}'
Respuesta
Una respuesta correcta devuelve el ID de flujo y la etiqueta correspondiente para el flujo de datos de borrador. Puede utilizar este ID más adelante para actualizar y publicar el flujo de datos.
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}
Publish el flujo de datos de borrador publish-your-draft-dataflow
Una vez que el borrador esté listo para publicarse, realice una solicitud de POST al extremo /flows
, proporcionando al mismo tiempo el ID del flujo de datos de borrador que desee publicar, así como una operación de acción para la publicación.
Formato de API
POST /flows/{FLOW_ID}/action?op=publish
op
op
en publish
.Solicitud
La siguiente solicitud publica el flujo de datos de borrador.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows/c9751426-dff8-49b0-965f-50defcf4187b/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-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 el ID y el etag
correspondiente del flujo de datos.
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}
Pasos siguientes
Al seguir este tutorial, ha aprendido a crear borradores de sus Flow Service entidades, así como a publicar estos borradores. Para obtener más información sobre las fuentes, lea la información general sobre fuentes.