Créez une connexion de base à Square à l’aide de l’API Flow Service.
Une connexion de base représente la connexion authentifiée entre une source et Adobe Experience Platform.
Ce tutoriel vous guide tout au long des étapes de création dʼune connexion de base pour Square à l’aide de l’Flow Service API.
Prise en main
Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :
- Sources : Experience Platform permet d’ingérer des données provenant de diverses sources tout en vous offrant la possibilité de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide des services Platform.
- Sandbox : Experience Platform fournit des environnements de test virtuels qui divisent une instance de plateforme unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience numérique.
Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour vous connecter à Square à l’aide de l’API Flow Service.
Collecter les informations d’identification requises
Pour connecter Flow Service à Square, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
hostclientIdclientSecretaccessTokenrefreshTokenconnectionSpec.id2acf109f-9b66-4d5e-bc18-ebb2adcff8d5Pour plus d’informations sur ces informations d’identification et sur la manière de les obtenir, consultez la Square documentation sur OAuth.
Utiliser les API Platform
Pour plus d’informations sur la manière d’effectuer avec succès des appels vers les API Platform, consultez le guide sur la Prise en main des API Platform.
Créer une connexion de base
Une connexion de base conserve les informations échangées entre votre source et Platform, y compris les informations d’authentification de votre source, l’état actuel de la connexion et votre identifiant de connexion de base unique. L’identifiant de connexion de base vous permet d’explorer et de parcourir des fichiers à partir de votre source et d’identifier les éléments spécifiques que vous souhaitez ingérer, y compris des informations concernant leurs types et formats de données.
Pour créer un identifiant de connexion de base, envoyez une requête POST au point d’entrée /connections et indiquez vos informations d’authentification Square dans les paramètres de la requête.
Format d’API
POST /connections
Requête
La requête suivante permet de créer une connexion de base pour 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"
}
}'
auth.params.hostauth.params.clientIdauth.params.clientSecretauth.params.accessTokenauth.params.refreshTokenconnectionSpec.id2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.Réponse
Une réponse réussie renvoie la nouvelle connexion, y compris son identifiant de connexion unique (id). Cet identifiant est nécessaire pour explorer vos données dans le tutoriel suivant.
{
"id": "24151d58-ffa7-4960-951d-58ffa7396097",
"etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""
}
Étapes suivantes
En suivant ce tutoriel, vous avez créé une connexion Square à l’aide de l’API Flow Service et obtenu la valeur d’identifiant unique de la connexion. Vous pouvez utiliser cet identifiant dans le tutoriel suivant lorsque vous apprendrez à explorer l'application de paiements à l'aide de l'API Flow Service.