Comment récupérer les règles de partage de données dans Zoho

La récupération des règles de partage de données dans Zoho CRM et Zoho Desk est simple grâce à des endpoints API dédiés — vous pouvez obtenir soit la liste complète des règles, soit une règle unique par son identifiant, selon votre cas d'usage.

Pourquoi c'est important

Les règles de partage de données contrôlent quels enregistrements sont visibles selon les rôles et les territoires dans votre organisation Zoho. L'audit ou l'inspection programmatique de ces règles est essentiel lors de l'intégration de nouveaux utilisateurs, du diagnostic de problèmes de visibilité, ou de l'automatisation des contrôles de gouvernance. En tant que support expert indépendant (Beam Help — et non le support officiel de Zoho), nous détaillons ci-dessous les approches pour CRM et Desk.

Étape par étape

Étape 1. S'authentifier et obtenir un jeton d'accès.

Avant d'appeler un endpoint de paramètres, votre intégration doit disposer d'un jeton d'accès OAuth valide. Le jeton est récupéré via le flux OAuth de Zoho et expire après la durée spécifiée dans le champ expiresin de la réponse du jeton (généralement 3600 secondes). Stockez la valeur accesstoken et renouvelez-la avant son expiration. ^[4]

Étape 2. Récupérer toutes les règles de partage de données dans Zoho CRM.

Envoyez une requête GET vers l'endpoint /settings/datasharingrules. Cela retourne la collection complète des règles de partage de données configurées pour votre organisation CRM. Aucun paramètre de chemin supplémentaire n'est requis. ^[2]

# Example call
response = client.get_data_sharing_rules()

Passez votre en-tête Authorization: Bearer <access_token> avec chaque requête. ^[4]

Étape 3. Récupérer une règle de partage de données par son identifiant dans Zoho CRM.

Lorsque vous n'avez besoin des détails que d'une seule règle, ajoutez l'identifiant de la règle au chemin : /settings/datasharingrules/{ruleid}. Remplacez {ruleid} par la chaîne d'identifiant réelle de la règle que vous souhaitez inspecter. ^[1]

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

Cet appel ciblé est plus efficace que la récupération de la liste complète lorsque vous connaissez déjà l'identifiant de la règle. ^[1]

Étape 4. Récupérer la documentation de gestion des règles de partage de données dans Zoho Desk.

Pour les environnements Zoho Desk, l'endpoint concerné est GET /api/v1/doc/datasharingrulesmanagemen. Cet endpoint accepte un paramètre optionnel p à des fins de pagination ou de filtrage. ^[3]

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

Assurez-vous que votre jeton OAuth Desk dispose du scope Desk.settings.READ approprié avant d'effectuer cet appel. ^[7]

Étape 5. Vérifier que vos scopes OAuth couvrent l'accès aux paramètres.

Pour Zoho CRM, votre jeton doit inclure ZohoCRM.org.ALL ou un scope équivalent au niveau de l'organisation pour lire les ressources de paramètres. Pour Zoho Desk, le scope requis est Desk.settings.READ (ou Desk.settings.ALL). Sans ces scopes, l'API retournera une erreur d'autorisation plutôt que les données des règles. ^[7]

Erreurs courantes

• Jeton manquant ou expiré. Si la clé accesstoken est absente de la réponse OAuth, l'intégration affichera une erreur au lieu de continuer. Vérifiez toujours que accesstoken existe dans le payload du jeton avant d'effectuer des appels en aval. ^[4]

• Mauvais endpoint pour le produit. L'endpoint des règles CRM (/settings/datasharingrules) et l'endpoint des règles Desk (/api/v1/doc/datasharingrulesmanagemen) sont distincts. Envoyer un jeton à portée CRM vers l'endpoint Desk — ou inversement — entraînera une erreur d'authentification ou une erreur de ressource introuvable. ^[1][2][3]

• Format de ruleid incorrect. L'endpoint pour une règle unique requiert une chaîne ruleid valide dans le chemin. Passer un identifiant nul, vide ou mal formaté entraînera l'échec de la requête ou un résultat inattendu. ^[1]

• Scopes Desk insuffisants. Zoho Desk dispose de définitions de scopes granulaires. Si votre jeton a été généré sans Desk.settings.READ, l'endpoint de gestion des règles de partage de données sera inaccessible même si d'autres scopes Desk sont présents. ^[7]

Points à vérifier

• Couverture des scopes : Vérifiez que votre jeton OAuth inclut ZohoCRM.org.ALL pour les appels CRM et Desk.settings.READ pour les appels Desk avant d'exécuter toute requête. ^[7]
• Validité du jeton : Confirmez que l'horodatage tokenexpiresat n'est pas dépassé ; renouvelez le jeton de manière proactive s'il est à quelques minutes de l'expiration. ^[4]
• URL de base et produit corrects : Vérifiez bien que les requêtes CRM ciblent le chemin /settings/datasharingrules et que les requêtes Desk ciblent /api/v1/doc/datasharingrulesmanagemen, car les mélanger produira des erreurs. ^[1][2][3]