Creare bozze del Flow Service entità che utilizzano l'API
È possibile utilizzare mode=draft
parametro di query in [Flow Service API] (https://www.adobe.io/experience-platform-apis/references/flow-service/) per impostare Flow Service entità quali le connessioni di base, le connessioni di origine, le connessioni di destinazione e i flussi di dati a uno stato di bozza.
Le bozze possono essere aggiornate in un secondo momento con nuove informazioni e quindi pubblicate quando sono pronte, utilizzando op=publish
parametro di query.
Questo tutorial descrive come impostare Flow Service allo stato di bozza e consentono di mettere in pausa e salvare i flussi di lavoro per il completamento in un secondo momento.
Introduzione
Questo tutorial richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
- Sorgenti: un Experience Platform consente di acquisire dati da varie origini, consentendoti allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi di Platform.
- Sandbox: Experienci Platform fornisce sandbox virtuali che permettono di suddividere una singola istanza Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.
Utilizzo delle API di Platform
Per informazioni su come effettuare correttamente chiamate alle API di Platform, consulta la guida su introduzione alle API di Platform.
Verifica il supporto della modalità bozza
È inoltre necessario verificare se l'ID della specifica di connessione e l'ID della specifica di flusso corrispondente dell'origine utilizzata sono abilitati per la modalità bozza.
accordion | ||
---|---|---|
Richiesta La richiesta seguente recupera le informazioni sulle specifiche di connessione per Azure File Storage: | ||
|
accordion | ||
---|---|---|
Risposta | ||
In caso di esito positivo, la risposta restituisce le informazioni sulle specifiche di connessione per l’origine. Per verificare se la modalità bozza è supportata per l’origine, verifica che
|
accordion | ||
---|---|---|
Richiesta La richiesta seguente recupera i dettagli delle specifiche di flusso per un’origine di archiviazione cloud: | ||
|
accordion | ||
---|---|---|
Risposta | ||
In caso di esito positivo, la risposta restituisce le informazioni sulle specifiche di flusso per l’origine. Per verificare se la modalità bozza è supportata per l’origine, verifica che
|
Creare una bozza di connessione di base create-a-draft-base-connection
Per creare una bozza di connessione di base, effettuare una richiesta POST al /connections
endpoint del Flow Service API e fornire mode=draft
come parametro di query.
Formato API
POST /connections?mode=draft
mode
mode
a draft
.Richiesta
La richiesta seguente crea una bozza di connessione di base per Azure File Storage origine:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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"
}
}'
Risposta
In caso di esito positivo, la risposta restituisce l’ID della connessione di base e l’etag corrispondente per la connessione di base bozza. Puoi usare questo ID in un secondo momento per aggiornare e pubblicare la connessione di base.
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Pubblicare la bozza di connessione di base publish-your-draft-base-connection
Quando la bozza è pronta per la pubblicazione, invia una richiesta POST al /connections
e fornire l'ID della bozza di connessione di base che si desidera pubblicare, nonché un'operazione di pubblicazione.
Formato API
POST /connections/{BASE_CONNECTION_ID}/action?op=publish
op
op
a publish
.Richiesta
La richiesta seguente pubblica la bozza della connessione di base per Azure File Storage creato in un passaggio precedente.
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}' \
Risposta
In caso di esito positivo, la risposta restituisce l’ID e l’e-mail corrispondente per la connessione di base pubblicata.
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Creare una bozza di connessione sorgente create-a-draft-source-connection
Per creare una bozza di connessione sorgente, effettua una richiesta POST al /sourceConnections
endpoint del Flow Service API e fornire mode=draft
come parametro di query.
Formato API
POST /sourceConnections?mode=draft
mode
mode
a draft
.Richiesta
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"
}
}'
Risposta
In caso di esito positivo, la risposta restituisce l’ID della connessione sorgente e l’eTag corrispondente per la connessione sorgente in stato di bozza. Puoi usare questo ID in un secondo momento per aggiornare e pubblicare la connessione sorgente.
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
Pubblicare la bozza della connessione sorgente publish-your-draft-source-connection
Quando la bozza è pronta per la pubblicazione, invia una richiesta POST al /sourceConnections
e fornire l'ID della bozza della connessione di origine che si desidera pubblicare, nonché un'operazione di pubblicazione.
Formato API
POST /sourceConnections/{SOURCE_CONNECTION_ID}/action?op=publish
op
op
a publish
.Richiesta
La richiesta seguente pubblica la bozza della connessione sorgente per Azure File Storage creato in un passaggio precedente.
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}' \
Risposta
In caso di esito positivo, la risposta restituisce l’ID e l’e-mail corrispondente per la connessione sorgente pubblicata.
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
Creare una bozza di connessione di destinazione create-a-draft-target-connection
Per creare una bozza di connessione di destinazione, effettua una richiesta POST al /targetConnections
endpoint del Flow Service API e fornire mode=draft
come parametro di query.
Formato API
POST /targetConnections?mode=draft
mode
mode
a draft
.Richiesta
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"
}
}'
Risposta
In caso di esito positivo, la risposta restituisce l’ID della connessione di destinazione e l’etag corrispondente per la bozza della connessione di destinazione. Puoi usare questo ID in un secondo momento per aggiornare e pubblicare la connessione di destinazione.
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
Pubblicare la bozza di connessione di destinazione publish-your-draft-target-connection
Quando la bozza è pronta per la pubblicazione, invia una richiesta POST al /targetConnections
e fornire l’ID della bozza di connessione di destinazione da pubblicare, nonché un’operazione di pubblicazione.
Formato API
POST /targetConnections/{TARGET_CONNECTION_ID}/action?op=publish
op
op
a publish
.Richiesta
La richiesta seguente pubblica la bozza di connessione di destinazione per Azure File Storage creato in un passaggio precedente.
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}' \
Risposta
In caso di esito positivo, la risposta restituisce l’ID e l’e-mail corrispondente per la connessione di destinazione pubblicata.
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
Creare un flusso di dati 2D create-a-draft-dataflow
Per impostare un flusso di dati come bozza, effettua una richiesta POST al /flows
endpoint durante l'aggiunta di mode=draft
come parametro di query. Questo consente di creare un flusso di dati e salvarlo come bozza.
Formato API
POST /flows?mode=draft
mode
mode
a draft
.Richiesta
La richiesta seguente crea un flusso di dati bozza.
'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"
}
}'
Risposta
In caso di esito positivo, la risposta restituisce l’ID di flusso e l’eTag corrispondente per il flusso di dati della bozza. Puoi utilizzare questo ID in un secondo momento per aggiornare e pubblicare il flusso di dati.
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}
Pubblicare il flusso di dati della bozza publish-your-draft-dataflow
Quando la bozza è pronta per la pubblicazione, invia una richiesta POST al /flows
endpoint, fornendo l’ID del flusso di dati bozza da pubblicare e un’operazione di pubblicazione.
Formato API
POST /flows/{FLOW_ID}/action?op=publish
op
op
a publish
.Richiesta
La richiesta seguente pubblica il flusso di dati della bozza.
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}' \
Risposta
In caso di esito positivo, la risposta restituisce l’ID e i corrispondenti etag
del flusso di dati.
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}
Passaggi successivi
Seguendo questa esercitazione, hai imparato a creare bozze delle tue Flow Service e pubblicare queste bozze. Per ulteriori informazioni sulle origini, consulta la panoramica sulle origini.