Beam Help
Demander de l'aide

How-to · Zoho CRM

Comment récupérer les préférences de service dans Zoho

Accédez aux paramètres de configuration et de préférences de service via l'API.

La récupération des préférences de service dans Zoho CRM s'effectue via une unique requête GET authentifiée vers l'endpoint /settings/service_preferences, qui retourne la configuration de service actuelle de votre organisation.


Pourquoi c'est important


Lorsque vous créez des intégrations ou des automatisations sur Zoho CRM, vous avez souvent besoin d'inspecter la configuration des services avant de prendre des décisions en aval. L'endpoint des préférences de service vous offre un instantané programmatique de ces paramètres sans avoir à naviguer dans l'interface. C'est particulièrement utile lors d'audits d'intégration, de comparaisons d'environnements, ou pour déboguer un comportement de service inattendu. En tant que support expert indépendant (et non le support officiel de Zoho), Beam Help documente ces pratiques pour que votre équipe puisse avancer plus rapidement.


Étape par étape


Étape 1. Assurez-vous que votre utilisateur dispose d'une connexion Zoho CRM active et authentifiée. Avant tout appel API, le système vérifie l'enregistrement de connexion stocké et actualise automatiquement le token OAuth s'il expire dans moins de 120 secondes — vous ne devriez donc jamais avoir à déclencher manuellement un rafraîchissement en cours de requête. [7]


Étape 2. Si le token d'accès doit être actualisé, la couche OAuth échange le refresh token stocké contre un nouveau et met à jour accesstoken ainsi que tokenexpiresat dans l'enregistrement de connexion. Vérifiez que accesstoken est présent dans la réponse avant de continuer ; s'il est absent, le rafraîchissement a échoué et l'appel doit être abandonné. [8]


Étape 3. Instanciez votre client API Zoho CRM en utilisant la connexion authentifiée. Transmettez apidomain, le accesstoken actuel, ainsi qu'un callback token_refresher afin que toute expiration en cours de requête puisse être gérée de manière transparente sans interrompre l'appel. [2]


Étape 4. Appelez l'endpoint des préférences de service en émettant une requête GET vers /settings/service_preferences en utilisant la version 6 de l'API. En Python, cela ressemble à ceci :


def get_service_preferences(self):
    return self.c.request("GET", "/settings/service_preferences", version=6)

La méthode retourne le payload complet des préférences de service pour votre organisation CRM. [1]


Étape 5. Analysez le corps de la réponse. Les données retournées reflètent la configuration actuelle des services. Stockez ou journalisez le résultat selon les besoins de votre audit ou de votre logique d'intégration. [1]


Erreurs courantes


  • Token manquant ou expiré. Si accesstoken n'est pas présent après une tentative de rafraîchissement, le client API ne disposera d'aucune accréditation valide et la requête échouera avec une erreur 401. Vérifiez toujours que le rafraîchissement du token a bien retourné une clé accesstoken valide avant de continuer. [8]

  • Mauvaise version de l'API. L'appel getservicepreferences cible explicitement la version 6 de l'API Zoho CRM. L'utilisation d'un numéro de version différent peut retourner une erreur 404 ou une structure de réponse inattendue. [1]

  • Aucun enregistrement de connexion trouvé. Si l'utilisateur n'a pas complété le flux OAuth, getzohoconnection retourne None et l'instance API ne peut pas être créée. Gérez ce cas en invitant l'utilisateur à se reconnecter avant toute tentative de récupération des paramètres. [2] [7]

  • Incompatibilité de domaine. Zoho opère sur plusieurs centres de données (par exemple, .com, .eu, .in). Le api_domain stocké dans l'enregistrement de connexion doit correspondre au centre de données où l'organisation CRM est hébergée, sinon les requêtes seront mal acheminées. [2]

Ce qu'il faut vérifier


  • Validité du token : Confirmez que accesstoken est présent et que tokenexpires_at est dans le futur avant que la requête ne soit envoyée. [7]
  • Version de l'API : Vérifiez que votre client transmet explicitement version=6 lors de l'appel à /settings/service_preferences. [1]
  • Intégrité de l'enregistrement de connexion : Vérifiez que apidomain et refreshtoken sont tous deux renseignés dans la connexion stockée ; un refresh_token manquant empêchera toute récupération en cas d'expiration du token. [7] [8]

Sources cited

  1. [1] GET /settings/service_preferences
  2. [2] server.py: get_zoho_api
  3. [3] server.py: chat
  4. [4] server.py: chat_plan_stream
  5. [5] server.py: chat_plan
  6. [6] server.py: get_zoho_connection
  7. [7] zoho_oauth.py
Récupérer les préférences de service dans Zoho | Beam Help — Beam Help