In alcuni casi, potrebbe essere necessario aggiornare i dettagli di una connessione sorgente esistente. Flow Service consente di aggiungere, modificare ed eliminare i dettagli di una connessione batch o in streaming esistente, compresi nome, descrizione e credenziali.
Questa esercitazione descrive i passaggi per aggiornare i dettagli e le credenziali di una connessione utilizzando Flow Service API.
Questa esercitazione richiede una connessione esistente e un ID di connessione valido. Se non disponi di una connessione esistente, seleziona l'origine scelta dalla panoramica di origini e segui i passaggi descritti prima di provare questa esercitazione.
Questa esercitazione richiede anche di avere una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
Per informazioni su come effettuare correttamente le chiamate alle API di Platform, consulta la guida su guida introduttiva alle API di Platform.
Il primo passo per aggiornare la connessione consiste nel recuperare i relativi dettagli utilizzando l’ID di connessione. Per recuperare i dettagli correnti della connessione, invia una richiesta di GET al Flow Service mentre fornisci l’ID di connessione della connessione che desideri aggiornare.
Formato API
GET /connections/{CONNECTION_ID}
Parametro | Descrizione |
---|---|
{CONNECTION_ID} |
L'unico id valore della connessione che si desidera recuperare. |
Richiesta
La seguente richiesta recupera informazioni relative alla connessione.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/139f6a5f-a78b-4744-9f6a-5fa78bd74431' \
-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}'
Risposta
Una risposta corretta restituisce i dettagli correnti della connessione, incluse le relative credenziali, l'identificatore univoco (id
) e versione . Il valore di versione è necessario per aggiornare la connessione.
{
"items": [
{
"createdAt": 1597973312000,
"updatedAt": 1597973312000,
"createdBy": "{CREATED_BY}",
"updatedBy": "{UPDATED_BY}",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxName": "{SANDBOX_NAME}",
"id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
"name": "E2E_SF Base_Connection",
"connectionSpec": {
"id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
"version": "1.0"
},
"state": "enabled",
"auth": {
"specName": "Basic Authentication",
"params": {
"securityToken": "{SECURITY_TOKEN}",
"password": "{PASSWORD}",
"username": "my-salesforce-account",
"environmentUrl": "login.salesforce.com"
}
},
"version": "\"1400dd53-0000-0200-0000-5f3f23450000\"",
"etag": "\"1400dd53-0000-0200-0000-5f3f23450000\""
}
]
}
Per aggiornare il nome, la descrizione e le credenziali della tua connessione, esegui una richiesta PATCH al Flow Service , fornendo al tempo stesso il tuo ID connessione, la versione e le nuove informazioni che desideri utilizzare.
La If-Match
l’intestazione è necessaria quando si effettua una richiesta PATCH. Il valore di questa intestazione è la versione univoca della connessione che si desidera aggiornare.
Formato API
PATCH /connections/{CONNECTION_ID}
Parametro | Descrizione |
---|---|
{CONNECTION_ID} |
L'unico id valore della connessione che si desidera aggiornare. |
Richiesta
La richiesta seguente fornisce un nuovo nome e una nuova descrizione, nonché un nuovo set di credenziali, con cui aggiornare la connessione.
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/connections/139f6a5f-a78b-4744-9f6a-5fa78bd74431' \
-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 'If-Match: 1400dd53-0000-0200-0000-5f3f23450000' \
-d '[
{
"op": "replace",
"path": "/auth/params",
"value": {
"username": "salesforce-connector-username",
"password": "{NEW_PASSWORD}",
"securityToken": "{NEW_SECURITY_TOKEN}"
}
},
{
"op": "replace",
"path": "/name",
"value": "Test salesforce connection"
},
{
"op": "add",
"path": "/description",
"value": "A test salesforce connection"
}
]'
Parametro | Descrizione |
---|---|
op |
Chiamata dell’operazione utilizzata per definire l’azione necessaria per aggiornare la connessione. Le operazioni includono: add , replace e remove . |
path |
Percorso del parametro da aggiornare. |
value |
Il nuovo valore con cui si desidera aggiornare il parametro. |
Risposta
Una risposta corretta restituisce l'ID di connessione e un tag aggiornato. Puoi verificare l’aggiornamento effettuando una richiesta GET al Flow Service , fornendo al tempo stesso l'ID di connessione.
{
"id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}
Seguendo questa esercitazione, hai aggiornato le credenziali e le informazioni associate alla tua connessione utilizzando Flow Service API. Per ulteriori informazioni sull’utilizzo dei connettori sorgente, consulta la sezione panoramica di origini.