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 Veeva CRM come parte dei parametri della richiesta.
Formato API
POST /connections
Richiesta
La richiesta seguente crea una connessione di base per Veeva 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": "Veeva CRM base connection",
"description": "Base Connection for Veeva CRM",
"auth": {
"specName": "Basic Authentication",
"params": {
"environmentUrl": "{ENVIRONMENT_URL}",
"username": "{USERNAME}",
"password": "{PASSWORD}",
"securityToken": "{SECURITY_TOKEN}"
}
},
"connectionSpec": {
"id": "fcad62f3-09b0-41d3-be11-449d5a621b69",
"version": "1.0"
}
}'
Parametro | Descrizione |
---|---|
name | Nome della connessione di base Veeva CRM. È possibile utilizzare questo nome per cercare la connessione di base Veeva CRM. |
description | Descrizione facoltativa della connessione di base Veeva CRM. |
auth.specName | Tipo di autenticazione utilizzato per la connessione. |
auth.params.environmentUrl | URL dell'istanza Veeva CRM. |
auth.params.username | Il valore del nome utente dell'account Veeva CRM. |
auth.params.password | Il valore della password dell'account Veeva CRM. |
auth.params.securityToken | Token di sicurezza per l'istanza Veeva CRM. |
connectionSpec.id | ID della specifica di connessione per Veeva CRM: fcad62f3-09b0-41d3-be11-449d5a621b69 . |
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\""
}