Crear una conexión base Zoho CRM mediante la API Flow Service

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Este tutorial lo guiará para crear una conexión base para Zoho CRM mediante la Flow Service API.

Primeros pasos

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos de varias fuentes al tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
  • Zonas protegidas: Experience Platform proporciona zonas protegidas virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que necesita conocer para conectarse correctamente a Zoho CRM mediante la API Flow Service.

Recopilar credenciales necesarias

Para que Flow Service se conecte con Zoho CRM, debe proporcionar valores para las siguientes propiedades de conexión:

Credencial
Descripción
endpoint
Extremo del servidor Zoho CRM al que realiza la solicitud.
accountsUrl
La dirección URL de cuentas se utiliza para generar los tokens de acceso y actualización. La dirección URL debe ser específica del dominio.
clientId
Identificador de cliente que corresponde con su cuenta de usuario Zoho CRM.
clientSecret
Secreto de cliente que corresponde a su cuenta de usuario Zoho CRM.
accessToken
El token de acceso autoriza el acceso seguro y temporal a su cuenta de Zoho CRM.
refreshToken
Un token de actualización es un token que se utiliza para generar un nuevo token de acceso, una vez que el token de acceso ha caducado.
connectionSpec.id
La especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. El id. de especificación de conexión para Zoho CRM es: 929e4450-0237-4ed2-9404-b7e1e0a00309.

Para obtener más información sobre estas credenciales, consulte la documentación sobre la Zoho CRM autenticación.

Uso de API de Platform

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía sobre introducción a las API de Platform.

Crear una conexión base

Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear un identificador de conexión base, realice una solicitud de POST al extremo /connections y proporcione las credenciales de autenticación Zoho CRM como parte de los parámetros de solicitud.

Formato de API

POST /connections

Solicitud

TIP
El dominio URL de las cuentas debe corresponder con la ubicación de dominio adecuada. A continuación se indican los distintos dominios y las direcciones URL de sus cuentas correspondientes:
  • Estados Unidos: https://accounts.zoho.com
  • Australia: https://accounts.zoho.com.au
  • Europa: https://accounts.zoho.eu
  • India: https://accounts.zoho.in
  • China: https://accounts.zoho.com.cn

La siguiente solicitud crea una conexión 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
Descripción
name
Nombre de su conexión base Zoho CRM. Puede usar este nombre para buscar su conexión base Zoho CRM.
description
Descripción opcional de la conexión base Zoho CRM.
auth.specName
Tipo de autenticación utilizado para la conexión.
auth.params.endpoint
Extremo del servidor Zoho CRM al que realiza la solicitud.
auth.params.accountsUrl
La dirección URL de cuentas se utiliza para generar los tokens de acceso y actualización. La dirección URL debe ser específica del dominio.
auth.params.clientId
Identificador de cliente que corresponde con su cuenta de usuario Zoho CRM.
auth.params.clientSecret
Secreto de cliente que corresponde a su cuenta de usuario Zoho CRM.
auth.params.accessToken
El token de acceso autoriza el acceso seguro y temporal a su cuenta de Zoho CRM.
auth.params.refreshToken
Un token de actualización es un token que se utiliza para generar un nuevo token de acceso, una vez que el token de acceso ha caducado.
connectionSpec.id
Id. de especificación de conexión para Zoho CRM: 929e4450-0237-4ed2-9404-b7e1e0a00309.

Respuesta

Una respuesta correcta devuelve detalles de la conexión base recién creada, incluido su identificador único (id). Este ID es necesario en el siguiente paso para crear una conexión de origen.

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

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión base Zoho mediante la API Flow Service. Puede utilizar este ID de conexión base en los siguientes tutoriales:

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