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"
        }
    }'
ParametroDescrizione
nameNome della connessione di base Zoho CRM. È possibile utilizzare questo nome per cercare la connessione di base Zoho CRM.
descriptionDescrizione facoltativa della connessione di base Zoho CRM.
auth.specNameTipo di autenticazione utilizzato per la connessione.
auth.params.endpointEndpoint del server Zoho CRM a cui si sta effettuando la richiesta.
auth.params.accountsUrlL’URL dell’account viene utilizzato per generare i token di accesso e di aggiornamento. L’URL deve essere specifico per il dominio.
auth.params.clientIdL'ID client corrispondente all'account utente Zoho CRM.
auth.params.clientSecretSegreto client corrispondente all'account utente Zoho CRM.
auth.params.accessTokenIl token di accesso autorizza l'accesso protetto e temporaneo all'account Zoho CRM.
auth.params.refreshTokenUn token di aggiornamento è un token utilizzato per generare un nuovo token di accesso, una volta scaduto il token di accesso.
connectionSpec.idID 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\""
}