DokumentationExperience PlatformAnvändarhandbok om Source Connectors

Skapa en Square-basanslutning med API:t Flow Service

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

Skapat för:

  • Utvecklare

En basanslutning representerar den autentiserade anslutningen mellan en källa och Adobe Experience Platform.

I den här självstudien får du hjälp med att skapa en basanslutning för Square med Flow Service API.

Komma igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

  • Källor: Experience Platform tillåter att data kan hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med Platform-tjänster.
  • Sandlådor: Experience Platform innehåller virtuella sandlådor som partitionerar en enda plattformsinstans till separata virtuella miljöer för att hjälpa till att utveckla och utveckla program för digitala upplevelser.

I följande avsnitt finns ytterligare information som du behöver känna till för att kunna ansluta till Square med API:t Flow Service.

Samla in nödvändiga inloggningsuppgifter

För att Flow Service ska kunna ansluta till Square måste du ange värden för följande anslutningsegenskaper:

Autentiseringsuppgifter
Beskrivning
host
URL:en för instansen Square.
clientId
Klient-ID som är associerat med ditt Square-konto.
clientSecret
Klienthemligheten som är associerad med ditt Square-konto.
accessToken
Åtkomsttoken används för att autentisera ditt Square-konto med OAuth 2.0-autentisering. Åtkomsttoken kan hämtas från Square.
refreshToken
Uppdateringstoken används för att generera nya åtkomsttoken när din nuvarande åtkomsttoken upphör att gälla. Uppdateringstoken kan hämtas från Square.
connectionSpec.id
Anslutningsspecifikationen returnerar en källas kopplingsegenskaper, inklusive autentiseringsspecifikationer för att skapa bas- och källanslutningarna. Anslutningsspecifikations-ID för Square är: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

Mer information om dessa autentiseringsuppgifter och hur du hämtar dem finns i Square dokumentationen om OAuth.

Använda plattforms-API:er

Mer information om hur du kan anropa plattforms-API:er finns i guiden Komma igång med plattforms-API:er.

Skapa en basanslutning

En basanslutning bevarar information mellan källan och plattformen, inklusive källans autentiseringsuppgifter, anslutningsstatus och ditt unika basanslutnings-ID. Med det grundläggande anslutnings-ID:t kan du utforska och navigera bland filer inifrån källan och identifiera de specifika objekt som du vill importera, inklusive information om deras datatyper och format.

Om du vill skapa ett grundläggande anslutnings-ID skickar du en POST till slutpunkten /connections och anger dina autentiseringsuppgifter för Square som en del av parametrarna för begäran.

API-format

POST /connections

Begäran

Följande begäran skapar en basanslutning för 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"
        }
    }'
Egenskap
Beskrivning
auth.params.host
URL:en för instansen Square.
auth.params.clientId
Klient-ID som är associerat med ditt Square-konto.
auth.params.clientSecret
Klienthemligheten som är associerad med ditt Square-konto.
auth.params.accessToken
Åtkomsttoken används för att autentisera ditt Square-konto med OAuth 2.0-autentisering. Åtkomsttoken kan hämtas från Square.
auth.params.refreshToken
Uppdateringstoken används för att generera nya åtkomsttoken när din nuvarande åtkomsttoken upphör att gälla. Uppdateringstoken kan hämtas från Square.
connectionSpec.id
Anslutningsspecifikations-ID Square: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.

Svar

Ett svar returnerar den nyligen skapade anslutningen, inklusive dess unika anslutnings-ID (id). Detta ID krävs för att utforska dina data i nästa självstudiekurs.

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

Nästa steg

Genom att följa den här självstudiekursen har du skapat en Square-anslutning med API:t Flow Service och fått anslutningens unika ID-värde. Du kan använda det här ID:t i nästa självstudiekurs när du lär dig hur du utforskar betalningsprogram med API:t för Flow Service.

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