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 Experience Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
  • Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Experience Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse besser entwickeln und weiterentwickeln können.

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

Sammeln erforderlicher Anmeldedaten

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.
clientId
Die mit Ihrem Square-Konto verknüpfte Client-ID.
clientSecret
Das mit Ihrem Square-Konto verknüpfte Client-Geheimnis.
accessToken
Das Zugriffstoken wird verwendet, um Ihr Square-Konto mit OAuth 2.0-Authentifizierung zu authentifizieren. Das Zugriffstoken kann von Square abgerufen werden.
refreshToken
Das Aktualisierungs-Token wird verwendet, um neue Zugriffs-Token zu generieren, sobald Ihr aktuelles Zugriffs-Token abläuft. Das Aktualisierungstoken kann von Square abgerufen werden.
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 lautet: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

Weitere Informationen zu diesen Anmeldeinformationen und deren Abruf finden Sie unter Square Dokumentation zu OAuth.

Verwenden von Experience Platform-APIs

Informationen zum erfolgreichen Aufrufen von Experience Platform-APIs finden Sie im Handbuch unter mit Experience Platform-APIs.

Erstellen einer Basisverbindung

Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Experience Platform gespeichert, einschließlich der Authentifizierungsdaten Ihrer Quelle, des aktuellen Verbindungsstatus und Ihrer eindeutigen ID 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-Authentifizierungs-Anmeldedaten 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.
auth.params.clientId
Die mit Ihrem Square-Konto verknüpfte Client-ID.
auth.params.clientSecret
Das mit Ihrem Square-Konto verknüpfte Client-Geheimnis.
auth.params.accessToken
Das Zugriffstoken wird verwendet, um Ihr Square-Konto mit OAuth 2.0-Authentifizierung zu authentifizieren. Das Zugriffstoken kann von Square abgerufen werden.
auth.params.refreshToken
Das Aktualisierungs-Token wird verwendet, um neue Zugriffs-Token zu generieren, sobald Ihr aktuelles Zugriffs-Token abläuft. Das Aktualisierungstoken kann von Square abgerufen werden.
connectionSpec.id
Die Spezifikations-ID der Square-Verbindung: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.

Antwort

Eine erfolgreiche Antwort gibt die neu erstellte Verbindung zurück, einschließlich ihrer 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 mithilfe der Flow Service-API erstellt und den eindeutigen ID-Wert der Verbindung erhalten. Sie können diese ID im nächsten Tutorial verwenden, in dem Sie lernen, wie Sie Zahlungsanwendung mithilfe der Flow Service-API erkunden.

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