Een Square basisverbinding met de Flow Service API

Een basisverbinding vertegenwoordigt de geverifieerde verbinding tussen een bron en Adobe Experience Platform.

Dit leerprogramma begeleidt u door de stappen om een basisverbinding tot stand te brengen voor Square met de Flow Service API.

Aan de slag

Deze handleiding vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:

  • Bronnen: Experience Platform staat gegevens toe om uit diverse bronnen worden opgenomen terwijl het voorzien van de capaciteit om, inkomende gegevens te structureren te etiketteren en te verbeteren gebruikend Platform diensten.
  • Sandboxen: Experience Platform biedt virtuele sandboxen die één enkele instantie van het Platform in afzonderlijke virtuele omgevingen verdelen om toepassingen voor digitale ervaringen te ontwikkelen en te ontwikkelen.

De volgende secties bevatten aanvullende informatie die u nodig hebt om verbinding te kunnen maken met Square met de Flow Service API.

Vereiste referenties verzamelen

Om Flow Service om te verbinden met Squaremoet u waarden opgeven voor de volgende eigenschappen van de verbinding:

Credentials
Beschrijving
host
De URL van de Square -instantie.
clientId
De client-id die aan uw Square account.
clientSecret
Het clientgeheim dat aan uw Square account.
accessToken
Het toegangstoken wordt gebruikt om uw voor authentiek te verklaren Square account met OAuth 2.0-verificatie. Het toegangstoken kan worden verkregen van Square.
refreshToken
Vernieuw teken wordt gebruikt om nieuwe toegangstoken te produceren zodra uw huidige toegangstoken verloopt. Het vernieuwingstoken kan worden verkregen van Square.
connectionSpec.id
De verbindingsspecificatie keert de eigenschappen van de bronschakelaar, met inbegrip van authentificatiespecificaties met betrekking tot het creëren van de basis en bronverbindingen terug. De verbindingsspecificatie-id voor Square is: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

Voor meer informatie over deze geloofsbrieven en hoe te om hen te verkrijgen, zie Square documentatie over OAuth.

Platform-API's gebruiken

Zie de handleiding voor informatie over hoe u aanroepen naar Platform-API's kunt uitvoeren aan de slag met Platform-API's.

Een basisverbinding maken

Een basisverbinding behoudt informatie tussen uw bron en Platform, met inbegrip van de de authentificatiegeloofsbrieven van uw bron, de huidige staat van de verbinding, en uw unieke identiteitskaart van de basisverbinding. Met de ID van de basisverbinding kunt u bestanden verkennen en door bestanden navigeren vanuit uw bron en kunt u de specifieke items identificeren die u wilt opnemen, inclusief informatie over hun gegevenstypen en indelingen.

Om een identiteitskaart van de basisverbinding te creëren, doe een verzoek van de POST aan /connections eindpunt terwijl het verstrekken van uw Square verificatiereferenties als onderdeel van de aanvraagparameters.

API-indeling

POST /connections

Verzoek

Met de volgende aanvraag wordt een basisverbinding gemaakt voor 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"
        }
    }'
Eigenschap
Beschrijving
auth.params.host
De URL van de Square -instantie.
auth.params.clientId
De client-id die aan uw Square account.
auth.params.clientSecret
Het clientgeheim dat aan uw Square account.
auth.params.accessToken
Het toegangstoken wordt gebruikt om uw voor authentiek te verklaren Square account met OAuth 2.0-verificatie. Het toegangstoken kan worden verkregen van Square.
auth.params.refreshToken
Vernieuw teken wordt gebruikt om nieuwe toegangstoken te produceren zodra uw huidige toegangstoken verloopt. Het vernieuwingstoken kan worden verkregen van Square.
connectionSpec.id
De Square Verbindingsspecificatie-id: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.

Antwoord

Met een geslaagde reactie wordt de nieuwe verbinding geretourneerd, inclusief de unieke verbindings-id (id). Deze id is vereist om uw gegevens te kunnen bekijken in de volgende zelfstudie.

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

Volgende stappen

Aan de hand van deze zelfstudie hebt u een Square verbinding met de Flow Service API en hebben de unieke id-waarde van de verbinding verkregen. U kunt deze id in de volgende zelfstudie gebruiken terwijl u leert hoe u betalingstoepassing verkennen met de Flow Service API.

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