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.
Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :
Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour vous connecter. Square en utilisant la variable Flow Service API.
Pour connecter Flow Service à Square, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
Informations d’identification | Description |
---|---|
host |
L’URL de la variable Square instance. |
clientId |
L’ID client associé à votre Square compte . |
clientSecret |
Le secret client associé à votre Square compte . |
accessToken |
Le jeton d’accès est utilisé pour authentifier votre Square compte avec authentification OAuth 2.0. Le jeton d’accès peut être obtenu à partir de Square. |
refreshToken |
Le jeton d’actualisation est utilisé pour générer de nouveaux jetons d’accès une fois que votre jeton d’accès actuel expire. Le jeton d’actualisation peut être obtenu à partir de Square. |
connectionSpec.id |
La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions de base et source. L’identifiant de spécification de connexion pour Square est : 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 |
Pour plus d’informations sur ces informations d’identification et sur la manière de les obtenir, reportez-vous à la section Square documentation sur OAuth.
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.
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"
}
}'
Propriété | Description |
---|---|
auth.params.host |
L’URL de la variable Square instance. |
auth.params.clientId |
L’ID client associé à votre Square compte . |
auth.params.clientSecret |
Le secret client associé à votre Square compte . |
auth.params.accessToken |
Le jeton d’accès est utilisé pour authentifier votre Square compte avec authentification OAuth 2.0. Le jeton d’accès peut être obtenu à partir de Square. |
auth.params.refreshToken |
Le jeton d’actualisation est utilisé pour générer de nouveaux jetons d’accès une fois que votre jeton d’accès actuel expire. Le jeton d’actualisation peut être obtenu à partir de Square. |
connectionSpec.id |
Le Square identifiant de spécification de connexion : 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 . |
Réponse
Une réponse réussie renvoie la nouvelle connexion de , 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\""
}
En suivant ce tutoriel, vous avez créé une Square connexion à l’aide de la fonction Flow Service et ont 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.