Crea un Square connessione di base utilizzando Flow Service API

Una connessione di base rappresenta la connessione autenticata tra un'origine e Adobe Experience Platform.

Questa esercitazione descrive i passaggi necessari per creare una connessione di base per Square utilizzando Flow Service API.

Introduzione

Questa guida richiede una buona comprensione dei seguenti componenti di Adobe Experience Platform:

  • Origini: Experience Platform consente l’acquisizione di dati da varie sorgenti, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo utilizzando Platform servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per connettersi correttamente a Square utilizzando Flow Service API.

Raccogli credenziali richieste

Per Flow Service per connettersi con Square, è necessario fornire valori per le seguenti proprietà di connessione:

Credenziali Descrizione
host L’URL della Square istanza.
clientId L'ID client associato al Square conto.
clientSecret Il segreto client associato al tuo Square conto.
accessToken Il token di accesso viene utilizzato per autenticare il Square account 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 una volta scaduto il 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 le chiamate alle API di Platform, consulta la guida su guida introduttiva alle API di Platform.

Creare una connessione di base

Una connessione di base conserva le informazioni tra l'origine e la piattaforma, incluse le credenziali di autenticazione dell'origine, lo stato corrente della connessione e l'ID di connessione di base univoco. L’ID di connessione di base consente di esplorare e navigare tra i file di origine e di identificare gli elementi specifici da acquisire, comprese le informazioni relative ai tipi di dati e ai formati corrispondenti.

Per creare un ID di connessione di base, invia una richiesta POST al /connections l'endpoint durante la fornitura del Square credenziali di autenticazione 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 L’URL della Square istanza.
auth.params.clientId L'ID client associato al Square conto.
auth.params.clientSecret Il segreto client associato al tuo Square conto.
auth.params.accessToken Il token di accesso viene utilizzato per autenticare il Square account 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 una volta scaduto il token di accesso corrente. Il token di aggiornamento può essere ottenuto da Square.
connectionSpec.id La Square ID specifica di connessione: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.

Risposta

Una risposta corretta restituisce la nuova connessione appena creata, incluso il relativo identificatore di connessione 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 un Square connessione tramite Flow Service e hanno ottenuto il valore ID univoco della connessione. Puoi usare questo ID nell'esercitazione successiva per scoprire come esplorare l’applicazione di pagamento tramite l’API del servizio di flusso.

In questa pagina