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 una connessione di base, effettuare una richiesta POST all'endpoint /connections
fornendo le credenziali di autenticazione Phoenix nel corpo della richiesta.
Formato API
POST /connections
Richiesta
La richiesta seguente crea una connessione di base per Phoenix:
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": "Phoenix test connection",
"description": "Phoenix test connection",
"auth": {
"specName": "Basic Authentication",
"params": {
"host": "{HOST}",
"username": "{USERNAME}",
"password":"{PASSWORD}",
"port": {PORT},
"httpPath": "{PATH}",
"enableSsl": {SSL}
}
},
"connectionSpec": {
"id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
"version": "1.0"
}
}'
Proprietà | Descrizione |
---|---|
auth.params.host | Host del server Phoenix. |
auth.params.username | Il nome utente associato alla connessione Phoenix. |
auth.params.password | La password associata alla connessione Phoenix. |
auth.params.port | Porta TCP per la connessione Phoenix. |
auth.params.httpPath | Percorso HTTP parziale per la connessione Phoenix. |
auth.params.enableSsl | Il valore booleano che specifica se le connessioni al server sono crittografate utilizzando SSL. |
connectionSpec.id | ID della specifica di connessione Phoenix: 102706fb-a5cd-42ee-afe0-bc42f017ff43 . |
Risposta
In caso di esito positivo, la risposta restituisce i dettagli della connessione appena creata, incluso il relativo identificatore univoco (id
). Questo ID è necessario per esplorare i dati nell’esercitazione successiva.
{
"id": "0d982fff-c443-403e-982f-ffc443f03e37",
"etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}