Cómo recuperar reglas de uso compartido de datos en Zoho

Recuperar reglas de uso compartido de datos en Zoho CRM y Zoho Desk es sencillo a través de endpoints de API dedicados: puedes obtener una lista completa de reglas o una sola regla por su ID, según tu caso de uso.

Por qué es importante

Las reglas de uso compartido de datos controlan qué registros son visibles entre roles y territorios en tu organización de Zoho. Auditar o inspeccionar estas reglas de forma programática es esencial al incorporar nuevos usuarios, solucionar problemas de visibilidad o automatizar controles de gobernanza. Como soporte experto independiente (Beam Help — no soporte oficial de Zoho), explicamos a continuación los enfoques tanto para CRM como para Desk.

Paso a paso

Paso 1. Autentícate y obtén un token de acceso.

Antes de llamar a cualquier endpoint de configuración, tu integración debe contar con un token de acceso OAuth válido. El token se obtiene mediante el flujo OAuth de Zoho y expira tras el período especificado en el campo expiresin de la respuesta del token (normalmente 3600 segundos). Guarda el valor de accesstoken y actualízalo antes de que caduque. ^[4]

Paso 2. Recupera todas las reglas de uso compartido de datos en Zoho CRM.

Envía una solicitud GET al endpoint /settings/datasharingrules. Esto devuelve la colección completa de reglas de uso compartido de datos configuradas para tu organización de CRM. No se requieren parámetros de ruta adicionales. ^[2]

# Example call
response = client.get_data_sharing_rules()

Incluye el encabezado Authorization: Bearer <access_token> en cada solicitud. ^[4]

Paso 3. Recupera una sola regla de uso compartido de datos por ID en Zoho CRM.

Cuando solo necesitas los detalles de una regla específica, añade el identificador de la regla a la ruta: /settings/datasharingrules/{ruleid}. Reemplaza {ruleid} con la cadena de ID real de la regla que deseas inspeccionar. ^[1]

# Example call
response = client.get_data_sharing_rule(rule_id="your_rule_id_here")

Esta llamada específica es más eficiente que obtener la lista completa cuando ya conoces el identificador de la regla. ^[1]

Paso 4. Recupera la documentación de gestión de reglas de uso compartido de datos en Zoho Desk.

Para entornos de Zoho Desk, el endpoint relevante es GET /api/v1/doc/datasharingrulesmanagemen. Este endpoint acepta un parámetro opcional p para fines de paginación o filtrado. ^[3]

# Example call
response = client.get_data_sharing_rules_management(p={"page": 1})

Asegúrate de que tu token OAuth de Desk incluya el ámbito Desk.settings.READ apropiado antes de realizar esta llamada. ^[7]

Paso 5. Confirma que tus ámbitos OAuth cubren el acceso a la configuración.

Para Zoho CRM, tu token debe incluir ZohoCRM.org.ALL o un ámbito equivalente a nivel de organización para leer recursos de configuración. Para Zoho Desk, el ámbito requerido es Desk.settings.READ (o Desk.settings.ALL). Sin estos ámbitos, la API devolverá un error de autorización en lugar de los datos de las reglas. ^[7]

Errores comunes

• Token ausente o caducado. Si la clave accesstoken no está presente en la respuesta OAuth, la integración mostrará un error en lugar de continuar. Valida siempre que accesstoken exista en el payload del token antes de realizar llamadas posteriores. ^[4]

• Endpoint incorrecto para el producto. El endpoint de reglas de CRM (/settings/datasharingrules) y el endpoint de reglas de Desk (/api/v1/doc/datasharingrulesmanagemen) son distintos. Enviar un token con ámbito de CRM al endpoint de Desk, o viceversa, resultará en un error de autenticación o de recurso no encontrado. ^[1][2][3]

• Formato incorrecto de ruleid. El endpoint de regla individual requiere una cadena ruleid válida en la ruta. Pasar un identificador nulo, vacío o con formato incorrecto hará que la solicitud falle o devuelva un resultado inesperado. ^[1]

• Ámbitos de Desk insuficientes. Zoho Desk tiene definiciones de ámbitos granulares. Si tu token se generó sin Desk.settings.READ, el endpoint de gestión de reglas de uso compartido de datos será inaccesible aunque estén presentes otros ámbitos de Desk. ^[7]

Qué verificar

• Cobertura de ámbitos: Verifica que tu token OAuth incluya ZohoCRM.org.ALL para llamadas de CRM y Desk.settings.READ para llamadas de Desk antes de ejecutar cualquier solicitud. ^[7]
• Validez del token: Confirma que la marca de tiempo tokenexpiresat no haya pasado; actualiza el token de forma proactiva si está a pocos minutos de caducar. ^[4]
• URL base y producto correctos: Comprueba que las solicitudes de CRM apunten a la ruta /settings/datasharingrules y las solicitudes de Desk apunten a /api/v1/doc/datasharingrulesmanagemen, ya que mezclarlas producirá errores. ^[1][2][3]