DocumentaçãoExperience PlatformGuia dos conectores de origem

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

Last update: Fri Nov 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor
WARNING
A origem Zoho CRM será substituída no final de junho de 2025.

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 Zoho CRM 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 do Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

As seções a seguir fornecem as informações adicionais que você precisa saber para se conectar com êxito ao Zoho CRM usando a API Flow Service.

Coletar credenciais necessárias

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

Credencial
Descrição
endpoint
O ponto de extremidade do servidor Zoho CRM ao qual você está fazendo sua solicitação.
accountsUrl
O URL das contas é usado para gerar os tokens de acesso e atualização. O URL deve ser específico do domínio.
clientId
A ID do cliente que corresponde à sua conta de usuário do Zoho CRM.
clientSecret
O segredo do cliente que corresponde à conta de usuário Zoho CRM.
accessToken
O token de acesso autoriza seu acesso seguro e temporário à sua conta do Zoho CRM.
refreshToken
Um token de atualização é um token usado para gerar um novo token de acesso depois que ele expirar.
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 Zoho CRM é: 929e4450-0237-4ed2-9404-b7e1e0a00309.

Para obter mais informações sobre essas credenciais, consulte a documentação sobre Zoho CRM autenticação.

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 Zoho CRM como parte dos parâmetros de solicitação.

Formato da API

POST /connections

Solicitação

TIP
O domínio da URL das contas deve corresponder ao local de domínio apropriado. A seguir estão os vários domínios e suas URLs de contas correspondentes:
  • Estados Unidos: https://accounts.zoho.com
  • Austrália: https://accounts.zoho.com.au
  • Europa: https://accounts.zoho.eu
  • Índia: https://accounts.zoho.in
  • China: https://accounts.zoho.com.cn

A solicitação a seguir cria uma conexão base para Zoho CRM:

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": "Zoho CRM base connection",
        "description": "Base Connection for Zoho CRM",
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                "endpoint": "{ENDPOINT}",
                "accountsUrl": "{ACCOUNTS_URL}",
                "clientId": "{CLIENT_ID}",
                "clientSecret": "{CLIENT_SECRET}",
                "accessToken": "{ACCESS_TOKEN}",
                "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "929e4450-0237-4ed2-9404-b7e1e0a00309",
            "version": "1.0"
        }
    }'
Parâmetro
Descrição
name
O nome da sua conexão base Zoho CRM. Você pode usar este nome para pesquisar sua conexão base Zoho CRM.
description
Uma descrição opcional para sua conexão de base Zoho CRM.
auth.specName
O tipo de autenticação usado para a conexão.
auth.params.endpoint
O ponto de extremidade do servidor Zoho CRM ao qual você está fazendo sua solicitação.
auth.params.accountsUrl
O URL das contas é usado para gerar os tokens de acesso e atualização. O URL deve ser específico do domínio.
auth.params.clientId
A ID do cliente que corresponde à sua conta de usuário do Zoho CRM.
auth.params.clientSecret
O segredo do cliente que corresponde à conta de usuário Zoho CRM.
auth.params.accessToken
O token de acesso autoriza seu acesso seguro e temporário à sua conta do Zoho CRM.
auth.params.refreshToken
Um token de atualização é um token usado para gerar um novo token de acesso depois que ele expirar.
connectionSpec.id
A ID da especificação de conexão para Zoho CRM: 929e4450-0237-4ed2-9404-b7e1e0a00309.

Resposta

Uma resposta bem-sucedida retorna detalhes da conexão base recém-criada, incluindo seu identificador exclusivo (id). Essa ID é necessária na próxima etapa para criar uma conexão de origem.

{
    "id": "2484f2df-c057-4ab5-84f2-dfc0577ab592",
    "etag": "\"10033e77-0000-0200-0000-5e96785b0000\""
}

Próximas etapas

Seguindo este tutorial, você criou uma conexão de base Zoho usando a API Flow Service. Você pode usar essa ID de conexão básica nos seguintes tutoriais:

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