DocumentazioneExperience PlatformGuida ai connettori di origini

Creare una connessione di base Square utilizzando l'API Flow Service

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:

Creato per:

  • Sviluppatore

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 Square utilizzando Flow Service API.

Introduzione

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 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 Square utilizzando l'API Flow Service.

Raccogli le credenziali richieste

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

Credenziali
Descrizione
host
URL dell'istanza Square.
clientId
ID client associato all'account Square.
clientSecret
Il segreto client associato al tuo account Square.
accessToken
Il token di accesso viene utilizzato per autenticare l'account Square con autenticazione OAuth 2.0. Il token di accesso può essere ottenuto da Square.
refreshToken
Il token di aggiornamento viene utilizzato per generare nuovi token di accesso dopo la scadenza del token di accesso corrente. Il token di aggiornamento può essere ottenuto da Square.
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 Square: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

Per ulteriori informazioni su queste credenziali e su come ottenerle, consulta la Square documentazione su OAuth.

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 Square come parte dei parametri della richiesta.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per Square:

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": "Square Base Connection",
        "description": "Square Base Connection",
        "auth": {
        "specName": "OAuth2 Refresh Code",
        "params": {
            "host": "{HOST}",
            "clientId": "{CLIENT_ID}",
            "clientSecret": "{CLIENT_SECRET}"
            "accessToken": "{ACCESS_TOKEN}"
            "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "2acf109f-9b66-4d5e-bc18-ebb2adcff8d5",
            "version": "1.0"
        }
    }'
Proprietà
Descrizione
auth.params.host
URL dell'istanza Square.
auth.params.clientId
ID client associato all'account Square.
auth.params.clientSecret
Il segreto client associato al tuo account Square.
auth.params.accessToken
Il token di accesso viene utilizzato per autenticare l'account Square con autenticazione OAuth 2.0. Il token di accesso può essere ottenuto da Square.
auth.params.refreshToken
Il token di aggiornamento viene utilizzato per generare nuovi token di accesso dopo la scadenza del token di accesso corrente. Il token di aggiornamento può essere ottenuto da Square.
connectionSpec.id
ID della specifica di connessione Square: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.

Risposta

In caso di esito positivo, la risposta restituisce la connessione appena creata, incluso l'identificatore univoco (id). Questo ID è necessario per esplorare i dati nell’esercitazione successiva.

{
    "id": "24151d58-ffa7-4960-951d-58ffa7396097",
    "etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""
}

Passaggi successivi

Seguendo questa esercitazione, hai creato una connessione Square utilizzando l'API Flow Service e hai ottenuto il valore ID univoco della connessione. È possibile utilizzare questo ID nell'esercitazione successiva mentre si apprende come esplorare l'applicazione di pagamento utilizzando l'API del servizio Flusso.

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