Uma conexão base representa a conexão autenticada entre uma origem e o Adobe Experience Platform.
Este tutorial guiará você pelas etapas para criar uma conexão básica para Square usando o Flow Service API.
Este guia requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:
As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito ao Square usando o Flow Service API.
A fim de Flow Service para se conectar com Square, você deve fornecer valores para as seguintes propriedades de conexão:
Credencial | Descrição |
---|---|
host |
O URL do Square instância. |
clientId |
A ID do cliente associada à Square conta. |
clientSecret |
O segredo do cliente associado à Square conta. |
accessToken |
O token de acesso é usado para autenticar seu Square conta com autenticação OAuth 2.0. O token de acesso pode ser obtido de Square. |
refreshToken |
O token de atualização é usado para gerar novos tokens de acesso depois que o token de acesso atual expira. O token de atualização pode ser obtido em Square. |
connectionSpec.id |
A especificação de conexão retorna as propriedades do conector de uma origem, incluindo especificações de autenticação relacionadas à criação das conexões de base e de origem. A ID da especificação de conexão para Square é: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 |
Para obter mais informações sobre essas credenciais e como obtê-las, consulte Square documentação sobre o OAuth.
Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual em introdução às APIs da Platform.
Uma conexão base retém informações entre sua origem e a Platform, incluindo as credenciais de autenticação da origem, o estado atual da conexão e sua ID de conexão base exclusiva. A ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar os itens específicos que deseja assimilar, incluindo informações sobre os tipos de dados e formatos.
Para criar um ID de conexão base, faça uma solicitação POST ao /connections
ao fornecer sua Square credenciais de autenticação como parte dos parâmetros de solicitação.
Formato da API
POST /connections
Solicitação
A solicitação a seguir cria uma conexão básica para 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"
}
}'
Propriedade | Descrição |
---|---|
auth.params.host |
O URL do Square instância. |
auth.params.clientId |
A ID do cliente associada à Square conta. |
auth.params.clientSecret |
O segredo do cliente associado à Square conta. |
auth.params.accessToken |
O token de acesso é usado para autenticar seu Square conta com autenticação OAuth 2.0. O token de acesso pode ser obtido de Square. |
auth.params.refreshToken |
O token de atualização é usado para gerar novos tokens de acesso depois que o token de acesso atual expira. O token de atualização pode ser obtido em Square. |
connectionSpec.id |
A variável Square ID da especificação de conexão: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 . |
Resposta
Uma resposta bem-sucedida retorna a conexão recém-criada, incluindo seu identificador de conexão exclusivo (id
). Essa ID é necessária para explorar seus dados no próximo tutorial.
{
"id": "24151d58-ffa7-4960-951d-58ffa7396097",
"etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""
}
Ao seguir este tutorial, você criou um Square conexão usando o Flow Service e obtiveram o valor de ID exclusivo da conexão. Você pode usar essa ID no próximo tutorial enquanto aprende a explorar o aplicativo de pagamentos usando a API de Serviço de Fluxo.