使用Flow Service API创建Square基本连接

基本连接表示源和Adobe Experience Platform之间的已验证连接。

本教程将指导您完成使用Flow Service API为Square创建基本连接的步骤。

快速入门

本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:

  • : Experience Platform允许从各种源摄取数据,同时允许您使用Platform服务来构建、标记和增强传入数据。
  • 沙盒: Experience Platform提供将单个Platform实例划分为多个单独的虚拟环境的虚拟沙盒,以帮助开发和改进数字体验应用程序。

以下部分提供使用Flow Service API成功连接到Square所需了解的其他信息。

收集所需的凭据

为了使Flow Service与Square连接,您必须提供以下连接属性的值:

凭据
描述
host
Square实例的URL。
clientId
与您的Square帐户关联的客户端ID。
clientSecret
与您的Square帐户关联的客户端密钥。
accessToken
访问令牌用于通过OAuth 2.0身份验证对您的Square帐户进行身份验证。 可从Square获取访问令牌。
refreshToken
刷新令牌用于在当前访问令牌过期后生成新的访问令牌。 可从Square获取刷新令牌。
connectionSpec.id
连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 Square的连接规范ID为: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

有关这些凭据以及如何获取这些凭据的更多信息,请参阅OAuth🔗上的Square 文档。

使用平台API

有关如何成功调用平台API的信息,请参阅平台API快速入门指南。

创建基本连接

基本连接会保留您的源和平台之间的信息,包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。

要创建基本连接ID,请在提供Square身份验证凭据作为POST参数的一部分时,向/connections端点请求请求。

API格式

POST /connections

请求

以下请求为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.host
Square实例的URL。
auth.params.clientId
与您的Square帐户关联的客户端ID。
auth.params.clientSecret
与您的Square帐户关联的客户端密钥。
auth.params.accessToken
访问令牌用于通过OAuth 2.0身份验证对您的Square帐户进行身份验证。 可从Square获取访问令牌。
auth.params.refreshToken
刷新令牌用于在当前访问令牌过期后生成新的访问令牌。 可从Square获取刷新令牌。
connectionSpec.id
Square连接规范ID: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

响应

成功的响应返回新创建的连接,包括其唯一连接标识符(id)。 在下个教程中,需要此ID才能浏览您的数据。

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

后续步骤

通过学习本教程,您已使用Flow Service API创建了Square连接并获取该连接的唯一ID值。 在学习如何使用流服务API浏览支付应用程序时,您可以在下一个教程中使用此ID

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