Flow Service viene utilizzato per raccogliere e centralizzare i dati dei clienti da varie origini all'interno di Adobe Experience Platform. Il servizio fornisce un'interfaccia utente e RESTful API da cui sono collegate tutte le origini supportate.
Questa esercitazione utilizza l'API Flow Service per guidarti attraverso i passaggi necessari per connettere la piattaforma a un account Microsoft Dynamics (in seguito denominato "Dynamics") tramite l'API del servizio di flusso.
Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per connettere correttamente la piattaforma a un account Dynamics utilizzando l'API Flow Service.
Affinché Flow Service possa connettersi a Dynamics, è necessario fornire i valori per le seguenti proprietà di connessione:
Credenziali | Descrizione |
---|---|
serviceUri |
L'URL del servizio dell'istanza Dynamics. |
username |
Il nome utente per l'account utente Dynamics. |
password |
La password dell'account Dynamics. |
servicePrincipalId |
L'ID client dell'account Dynamics. Questo ID è richiesto quando si utilizzano l'entità del servizio e l'autenticazione basata sulle chiavi. |
servicePrincipalKey |
La chiave segreta principale del servizio. Questa credenziale è necessaria quando si utilizzano l'entità del servizio e l'autenticazione basata sulle chiavi. |
Per ulteriori informazioni su come iniziare, visitare this Dynamics document.
Questa esercitazione fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consultate la sezione relativa a come leggere chiamate API di esempio nella guida alla risoluzione dei problemi del Experience Platform .
Per effettuare chiamate alle API della piattaforma, è innanzitutto necessario completare l'esercitazione sull'autenticazione a1/>. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte chiamate API di Experience Platform, come illustrato di seguito:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Tutte le risorse in Experience Platform, incluse quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API della piattaforma richiedono un'intestazione che specifica il nome della sandbox in cui avrà luogo l'operazione:
x-sandbox-name: {SANDBOX_NAME}
Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione aggiuntiva per il tipo di supporto:
Content-Type: application/json
Una connessione specifica un'origine e contiene le credenziali per tale origine. È necessaria una sola connessione per ogni account Dynamics, in quanto può essere utilizzata per creare più flussi di dati per inserire dati diversi.
Per creare una connessione Dynamics utilizzando l'autenticazione di base, effettuare una richiesta di POST all'API Flow Service fornendo al contempo i valori per le connessioni serviceUri
, username
e password
.
Formato API
POST /connections
Richiesta
Per creare una connessione Dynamics, è necessario fornire l'ID univoco della specifica di connessione come parte della richiesta di POST. L'ID della specifica di connessione per Dynamics è 38ad80fe-8b06-4938-94f4-d4ee80266b07
.
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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Dynamics connection",
"description": "Dynamics connection using basic auth",
"auth": {
"specName": "Basic Authentication for Dynamics-Online",
"params": {
"serviceUri": "{SERVICE_URI}",
"username": "{USERNAME}",
"password": "{PASSWORD}"
}
},
"connectionSpec": {
"id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
"version": "1.0"
}
}'
Proprietà | Descrizione |
---|---|
auth.params.serviceUri |
URI del servizio associato all'istanza Dynamics. |
auth.params.username |
Il nome utente associato al tuo account Dynamics. |
auth.params.password |
La password associata al tuo account Dynamics. |
connectionSpec.id |
Specifica di connessione id dell'account Dynamics recuperato nel passaggio precedente. |
Risposta
Una risposta corretta restituisce la nuova connessione creata, incluso il relativo identificatore univoco (id
). Questo ID è necessario per esplorare il sistema CRM nel passaggio successivo.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
Per creare una connessione Dynamics utilizzando l'autenticazione basata sulle chiavi dell'entità del servizio, effettuare una richiesta di POST all'API Flow Service fornendo al contempo i valori per le connessioni serviceUri
, servicePrincipalId
e servicePrincipalKey
.
Formato API
POST /connections
Richiesta
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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Dynamics connection",
"description": "Dynamics connection using key-based authentication",
"auth": {
"specName": "Service Principal Key Based Authentication",
"params": {
"serviceUri": "{SERVICE_URI}",
"servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
"servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
}
},
"connectionSpec": {
"id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
"version": "1.0"
}
}'
Proprietà | Descrizione |
---|---|
auth.params.serviceUri |
URI del servizio associato all'istanza Dynamics. |
auth.params.servicePrincipalId |
L'ID client dell'account Dynamics. Questo ID è richiesto quando si utilizzano l'entità del servizio e l'autenticazione basata sulle chiavi. |
auth.params.servicePrincipalKey |
La chiave segreta principale del servizio. Questa credenziale è necessaria quando si utilizzano l'entità del servizio e l'autenticazione basata sulle chiavi. |
Risposta
Una risposta corretta restituisce la nuova connessione creata, incluso il relativo identificatore univoco (id
). Questo ID è necessario per esplorare il sistema CRM nel passaggio successivo.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
Seguendo questa esercitazione, hai creato una connessione Dynamics utilizzando l'API Flow Service e hai ottenuto il valore ID univoco della connessione. Puoi utilizzare questo ID nell'esercitazione successiva per imparare a esplorare i sistemi CRM utilizzando l'API del servizio di flusso](…/…/explore/crm.md).[