Aggiornare gli account utilizzando l’API del servizio Flusso

In alcuni casi, potrebbe essere necessario aggiornare i dettagli di una connessione di base esistente. Flow Service consente di aggiungere, modificare ed eliminare i dettagli di una connessione batch o streaming esistente, inclusi nome, descrizione e credenziali.

Questo tutorial illustra i passaggi necessari per aggiornare i dettagli e le credenziali di una connessione tramite l'Flow Service API.

Introduzione

Questo tutorial richiede una connessione esistente e un ID connessione valido. Se non disponi di una connessione esistente, seleziona l'origine scelta dalla panoramica origini e segui i passaggi descritti prima di provare questa esercitazione.

Questo tutorial richiede anche una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente chiamate alle API di Platform, consulta la guida in guida introduttiva alle API di Platform.

Cerca dettagli di connessione

Il primo passaggio nell’aggiornamento della connessione consiste nel recuperarne i dettagli utilizzando il tuo ID connessione. Per recuperare i dettagli correnti della connessione, effettuare una richiesta di GET all'API Flow Service fornendo l'ID della connessione che si desidera aggiornare.

Formato API

GET /connections/{CONNECTION_ID}

Richiesta

La richiesta seguente 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

In caso di esito positivo, la risposta restituisce i dettagli correnti della connessione, incluse le credenziali, l'identificatore univoco (id) e la versione. Per aggiornare la connessione è necessario il valore della versione.

{
    "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\""
        }
    ]
}

Aggiorna connessione

Per aggiornare il nome, la descrizione e le credenziali della connessione, eseguire una richiesta PATCH all'API Flow Service fornendo l'ID di connessione, la versione e le nuove informazioni che si desidera utilizzare.

Formato API

PATCH /connections/{CONNECTION_ID}

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"
        }
    ]'

Risposta

In caso di esito positivo, la risposta restituisce l’ID di connessione e un tag aggiornato. È possibile verificare l'aggiornamento effettuando una richiesta di GET all'API Flow Service e fornendo l'ID di connessione.

{
    "id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

Passaggi successivi

Seguendo questa esercitazione, hai aggiornato le credenziali e le informazioni associate alla connessione utilizzando l'API Flow Service. Per ulteriori informazioni sull'utilizzo dei connettori di origine, vedere panoramica origini.