Creare una connessione di base Zoho CRM utilizzando l'API Flow Service

Una connessione di base rappresenta la connessione autenticata tra un'origine e Adobe Experience Platform.

Questo tutorial illustra i passaggi necessari per creare una connessione di base per Zoho CRM utilizzando Flow Service API.

Guida introduttuva

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Origini: Experience Platform consente l'acquisizione di dati da varie origini e consente di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Platform.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettersi correttamente a Zoho CRM utilizzando l'API Flow Service.

Raccogli le credenziali richieste

Affinché Flow Service possa connettersi a Zoho CRM, è necessario fornire i valori per le proprietà di connessione seguenti:

Credenziali
Descrizione
endpoint
Endpoint del server Zoho CRM a cui si sta effettuando la richiesta.
accountsUrl
L’URL dell’account viene utilizzato per generare i token di accesso e di aggiornamento. L’URL deve essere specifico per il dominio.
clientId
L'ID client corrispondente all'account utente Zoho CRM.
clientSecret
Segreto client corrispondente all'account utente Zoho CRM.
accessToken
Il token di accesso autorizza l'accesso protetto e temporaneo all'account Zoho CRM.
refreshToken
Un token di aggiornamento è un token utilizzato per generare un nuovo token di accesso, una volta scaduto il token di accesso.
connectionSpec.id
La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. ID della specifica di connessione per Zoho CRM: 929e4450-0237-4ed2-9404-b7e1e0a00309.

Per ulteriori informazioni su queste credenziali, consulta la documentazione sull'Zoho CRM autenticazione.

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.

Creare una connessione di base

Una connessione di base mantiene le informazioni tra l’origine e Platform, incluse le credenziali di autenticazione dell’origine, lo stato corrente della connessione e l’ID univoco della connessione di base. L’ID della connessione di base consente di esplorare e navigare tra i file dall’interno dell’origine e identificare gli elementi specifici che desideri acquisire, comprese le informazioni relative ai tipi di dati e ai formati.

Per creare un ID di connessione di base, effettuare una richiesta POST all'endpoint /connections fornendo le credenziali di autenticazione Zoho CRM come parte dei parametri della richiesta.

Formato API

POST /connections

Richiesta

TIP
Il dominio dell’URL dell’account deve corrispondere alla posizione di dominio appropriata. Di seguito sono riportati i vari domini e gli URL dei relativi account:
  • Stati Uniti: https://accounts.zoho.com
  • Australia: https://accounts.zoho.com.au
  • Europa: https://accounts.zoho.eu
  • India: https://accounts.zoho.in
  • Cina: https://accounts.zoho.com.cn

La richiesta seguente crea una connessione di base per Zoho CRM:

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: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json'
    -d '{
        "name": "Zoho CRM base connection",
        "description": "Base Connection for Zoho CRM",
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                "endpoint": "{ENDPOINT}",
                "accountsUrl": "{ACCOUNTS_URL}",
                "clientId": "{CLIENT_ID}",
                "clientSecret": "{CLIENT_SECRET}",
                "accessToken": "{ACCESS_TOKEN}",
                "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "929e4450-0237-4ed2-9404-b7e1e0a00309",
            "version": "1.0"
        }
    }'
Parametro
Descrizione
name
Nome della connessione di base Zoho CRM. È possibile utilizzare questo nome per cercare la connessione di base Zoho CRM.
description
Descrizione facoltativa della connessione di base Zoho CRM.
auth.specName
Tipo di autenticazione utilizzato per la connessione.
auth.params.endpoint
Endpoint del server Zoho CRM a cui si sta effettuando la richiesta.
auth.params.accountsUrl
L’URL dell’account viene utilizzato per generare i token di accesso e di aggiornamento. L’URL deve essere specifico per il dominio.
auth.params.clientId
L'ID client corrispondente all'account utente Zoho CRM.
auth.params.clientSecret
Segreto client corrispondente all'account utente Zoho CRM.
auth.params.accessToken
Il token di accesso autorizza l'accesso protetto e temporaneo all'account Zoho CRM.
auth.params.refreshToken
Un token di aggiornamento è un token utilizzato per generare un nuovo token di accesso, una volta scaduto il token di accesso.
connectionSpec.id
ID della specifica di connessione per Zoho CRM: 929e4450-0237-4ed2-9404-b7e1e0a00309.

Risposta

In caso di esito positivo, la risposta restituisce i dettagli della connessione di base appena creata, incluso il relativo identificatore univoco (id). Questo ID è necessario nel passaggio successivo per creare una connessione sorgente.

{
    "id": "2484f2df-c057-4ab5-84f2-dfc0577ab592",
    "etag": "\"10033e77-0000-0200-0000-5e96785b0000\""
}

Passaggi successivi

Seguendo questa esercitazione, è stata creata una connessione di base Zoho utilizzando l'API Flow Service. Puoi utilizzare questo ID connessione di base nelle seguenti esercitazioni:

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089