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 FTP come parte dei parametri della richiesta.
Formato API
POST /connections
Richiesta
La richiesta seguente crea una connessione di base per FTP:
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": "FTP connector with password",
"description": "FTP connector password",
"auth": {
"specName": "Basic Authentication for FTP",
"params": {
"host": "{HOST}",
"userName": "{USERNAME}",
"password": "{PASSWORD}"
}
},
"connectionSpec": {
"id": "fb2e94c9-c031-467d-8103-6bd6e0a432f2",
"version": "1.0"
}
}'
Proprietà | Descrizione |
---|---|
auth.params.host | Il nome host del server FTP. |
auth.params.username | Il nome utente associato al server FTP. |
auth.params.password | La password associata al server FTP. |
connectionSpec.id | ID specifica connessione server FTP: fb2e94c9-c031-467d-8103-6bd6e0a432f2 |
Risposta
In caso di esito positivo, la risposta restituisce l'identificatore univoco (id
) della connessione appena creata. Questo ID è necessario per esplorare il server FTP nella prossima esercitazione.
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
Passaggi successivi
Seguendo questa esercitazione, hai creato una connessione FTP utilizzando l'API Flow Service e hai ottenuto il valore ID univoco della connessione. Puoi usare questo ID connessione per esplorare gli archivi cloud utilizzando l'API del servizio Flusso.