DocumentaçãoExperience PlatformGuia dos conectores de origem

Criar uma conexão de base Square usando a API Flow Service

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor

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 a Flow Service API.

Introdução

Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:

  • Fontes: Experience Platform permite que os dados sejam assimilados de várias fontes e fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços do Platform.
  • Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância da Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito ao Square usando a API Flow Service.

Coletar credenciais necessárias

Para que Flow Service se conecte a Square, você deve fornecer valores para as seguintes propriedades de conexão:

Credencial
Descrição
host
A URL da instância Square.
clientId
A ID do cliente associada à sua conta do Square.
clientSecret
O segredo do cliente associado à sua conta do Square.
accessToken
O token de acesso é usado para autenticar sua conta do Square com a 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 de 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 a Square documentação sobre OAuth.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual sobre introdução às APIs da Platform.

Criar uma conexão básica

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 uma ID de conexão base, faça uma solicitação POST para o ponto de extremidade /connections enquanto fornece suas credenciais de autenticação Square como parte dos parâmetros de solicitação.

Formato da API

POST /connections

Solicitação

A solicitação a seguir cria uma conexão base 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
A URL da instância Square.
auth.params.clientId
A ID do cliente associada à sua conta do Square.
auth.params.clientSecret
O segredo do cliente associado à sua conta do Square.
auth.params.accessToken
O token de acesso é usado para autenticar sua conta do Square com a 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 de Square.
connectionSpec.id
A ID da especificação de conexão Square: 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\""
}

Próximas etapas

Seguindo este tutorial, você criou uma conexão Square usando a API Flow Service e obteve o valor de identificador 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.

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