Erstellen einer Square-Basisverbindung mithilfe der Flow Service-API

Eine Basisverbindung stellt die authentifizierte Verbindung zwischen einer Quelle und Adobe Experience Platform dar.

Dieses Tutorial führt Sie durch die Schritte zum Erstellen einer Basisverbindung für Square mithilfe der Flow Service -API.

Erste Schritte

Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:

  • Quellen: Experience Platform ermöglicht die Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
  • Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen aufteilen, um die Entwicklung und Weiterentwicklung von Programmen für digitale Erlebnisse zu erleichtern.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um eine erfolgreiche Verbindung zu Square mithilfe der Flow Service API.

Sammeln erforderlicher Anmeldeinformationen

Damit Flow Service eine Verbindung mit Square herstellen kann, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:

Anmeldedaten Beschreibung
host Die URL der Square -Instanz.
clientId Die mit Ihrer Square -Konto.
clientSecret Das Client-Geheimnis, das mit Ihrem Square -Konto.
accessToken Das Zugriffstoken wird verwendet, um Ihre Square Konto mit OAuth 2.0-Authentifizierung. Das Zugriffstoken kann abgerufen werden über Square.
refreshToken Das Aktualisierungstoken wird verwendet, um neue Zugriffstoken zu generieren, sobald Ihr aktuelles Zugriffstoken abläuft. Das Aktualisierungstoken kann abgerufen werden von Square.
connectionSpec.id Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich der Authentifizierungsspezifikationen für die Erstellung der Basis- und Quellverbindungen. Die Verbindungsspezifikations-ID für Square ist: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

Weitere Informationen zu diesen Anmeldedaten und zum Abrufen dieser Anmeldedaten finden Sie im Abschnitt Square Dokumentation zu OAuth.

Verwenden von Platform-APIs

Informationen zum Aufrufen von Platform-APIs finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.

Erstellen einer Basisverbindung

Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Platform gespeichert, einschließlich der Authentifizierungsdaten Ihrer Quelle, des aktuellen Verbindungsstatus und Ihrer eindeutigen Kennung der Basisverbindung. Mit der Kennung der Basisverbindung können Sie Dateien aus Ihrer Quelle heraus analysieren und darin navigieren und die spezifischen Elemente identifizieren, die Sie erfassen möchten, einschließlich Informationen zu ihren Datentypen und Formaten.

Um eine Basisverbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den Endpunkt /connections und geben Sie dabei Ihre Square-Authentifizierungsdaten als Teil der Anfrageparameter an.

API-Format

POST /connections

Anfrage

Die folgende Anfrage erstellt eine Basisverbindung 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"
        }
    }'
Eigenschaft Beschreibung
auth.params.host Die URL der Square -Instanz.
auth.params.clientId Die mit Ihrer Square -Konto.
auth.params.clientSecret Das Client-Geheimnis, das mit Ihrem Square -Konto.
auth.params.accessToken Das Zugriffstoken wird verwendet, um Ihre Square Konto mit OAuth 2.0-Authentifizierung. Das Zugriffstoken kann abgerufen werden über Square.
auth.params.refreshToken Das Aktualisierungstoken wird verwendet, um neue Zugriffstoken zu generieren, sobald Ihr aktuelles Zugriffstoken abläuft. Das Aktualisierungstoken kann abgerufen werden von Square.
connectionSpec.id Die Square Verbindungsspezifikations-ID: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.

Antwort

Eine erfolgreiche Antwort gibt die neu erstellte Verbindung zurück, einschließlich der eindeutigen Verbindungskennung (id). Diese ID ist erforderlich, um Ihre Daten im nächsten Tutorial zu untersuchen.

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

Nächste Schritte

In diesem Tutorial haben Sie eine Square Verbindung mithilfe der Flow Service API und haben den eindeutigen ID-Wert der Verbindung erhalten. Sie können diese ID im nächsten Tutorial verwenden, während Sie lernen, wie Sie Durchsuchen der Zahlungsanwendung mit der Flow Service-API.

Auf dieser Seite