Een Square basisverbinding maken 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 voor Square tot stand te brengen gebruikend 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 van diverse bronnen worden opgenomen terwijl het voorzien van u van de capaciteit om, inkomende gegevens te structureren te etiketteren en te verbeteren gebruikend Platform diensten.
  • Sandboxes: Experience Platform verstrekt virtuele zandbakken die één enkele instantie van het Platform in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.

In de volgende secties vindt u aanvullende informatie die u moet weten voordat u verbinding kunt maken met Square via de Flow Service API.

Vereiste referenties verzamelen

Flow Service kan alleen verbinding maken met Square als u waarden opgeeft voor de volgende verbindingseigenschappen:

Credentials
Beschrijving
host
De URL van de instantie Square .
clientId
De client-id die aan uw Square -account is gekoppeld.
clientSecret
Het clientgeheim dat aan uw Square -account is gekoppeld.
accessToken
Het toegangstoken wordt gebruikt om uw Square rekening met authentificatie te verifiëren OAuth 2.0. Het toegangstoken kan uit Square worden verkregen.
refreshToken
Vernieuw teken wordt gebruikt om nieuwe toegangstoken te produceren zodra uw huidige toegangstoken verloopt. Het token voor vernieuwen kan worden opgehaald uit 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 de Square documentatie over OAuth.

Platform-API's gebruiken

Voor informatie over hoe te om vraag aan Platform APIs met succes te maken, zie de gids op begonnen wordt met Platform APIs.

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.

Als u een basis-verbindings-id wilt maken, vraagt u een POST naar het /connections -eindpunt en geeft u de Square -verificatiegegevens op als onderdeel van de aanvraagparameters.

API formaat

POST /connections

Verzoek

Met de volgende aanvraag wordt een basisverbinding voor Square gemaakt:

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 instantie Square .
auth.params.clientId
De client-id die aan uw Square -account is gekoppeld.
auth.params.clientSecret
Het clientgeheim dat aan uw Square -account is gekoppeld.
auth.params.accessToken
Het toegangstoken wordt gebruikt om uw Square rekening met authentificatie te verifiëren OAuth 2.0. Het toegangstoken kan uit Square worden verkregen.
auth.params.refreshToken
Vernieuw teken wordt gebruikt om nieuwe toegangstoken te produceren zodra uw huidige toegangstoken verloopt. Het token voor vernieuwen kan worden opgehaald uit Square .
connectionSpec.id
The Square connection specification ID: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 .

Reactie

Een succesvolle reactie keert de pas gecreëerde verbinding, met inbegrip van zijn unieke verbindings herkenningsteken (id) terug. 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 gemaakt met de Flow Service API en hebt u de unieke id-waarde van de verbinding verkregen. U kunt deze identiteitskaart in het volgende leerprogramma gebruiken aangezien u leert hoe te betalingstoepassing onderzoeken gebruikend de Dienst API van de Stroom.

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