Comment récupérer les paramètres de suivi du temps dans Zoho Desk

La récupération des paramètres de suivi du temps dans Zoho Desk est simple via une seule requête GET vers le point de terminaison /api/v1/timetracking/settings, à condition que votre client soit authentifié et que votre identifiant d'organisation soit correctement configuré.

Pourquoi c'est important

Lorsque vous créez des intégrations ou des automatisations autour de la fonctionnalité de suivi du temps de Zoho Desk, vous devez souvent inspecter la configuration actuelle avant d'apporter des modifications — par exemple, avant de décider de créer, mettre à jour ou supprimer des paramètres. Récupérer les paramètres en premier vous donne une base fiable et aide à éviter d'écraser des valeurs involontairement. Il s'agit également d'une étape de diagnostic utile pour résoudre les comportements inattendus du suivi du temps dans votre helpdesk.

Étape par étape

Étape 1. Assurez-vous que votre connexion Zoho Desk est initialisée avec un jeton d'accès valide et un identifiant d'organisation. Le ZohoDeskClient nécessite votre domaine API, un jeton d'accès actuel et l'orgid associé à votre portail Desk. Si l'orgid n'est pas encore enregistré, le client peut le découvrir automatiquement en appelant le point de terminaison des organisations et en conservant le premier résultat. ^[3]

Étape 2. Vérifiez que votre jeton d'accès est à jour avant d'effectuer l'appel. Notre couche d'intégration vérifie si le jeton expire dans les 120 secondes et le renouvelle de manière proactive en utilisant le refreshtoken stocké, en mettant à jour l'enregistrement de la base de données avec les nouvelles valeurs accesstoken et tokenexpiresat. Cela évite les erreurs 401 en cours de requête. ^[4]

Étape 3. Instanciez votre objet ZohoDeskApi en utilisant le ZohoDeskClient authentifié, puis appelez la méthode gettimetrack_settings. Cela émet une requête GET vers /api/v1/timetracking/settings. Un dictionnaire de paramètres de requête optionnel (p) peut être transmis si vous avez besoin de filtrer ou de limiter la réponse, mais il n'est pas requis pour une récupération de base. ^[1]

# Exemple d'utilisation
settings = api.get_time_track_settings(p={})
print(settings)

Étape 4. Inspectez le dictionnaire de réponse renvoyé par l'appel. Les données refléteront la configuration actuelle du suivi du temps pour votre organisation Zoho Desk. Si vous devez modifier ces paramètres par la suite, utilisez PATCH /api/v1/timetracking/settings via updatetimetrack_settings(data, p), en transmettant uniquement les champs que vous souhaitez modifier. ^[2]

Étape 5. Si vous devez repartir de zéro, notez que l'API expose également POST /api/v1/timetracking/settings pour créer une nouvelle configuration et DELETE /api/v1/timetracking/settings pour supprimer entièrement la configuration existante — ainsi, l'appel GET s'intègre naturellement dans un modèle de lecture avant écriture. ^[7][5]

Erreurs courantes

• orgid manquant : Zoho Desk exige que l'identifiant d'organisation soit envoyé avec chaque requête API. Si deskorgid est vide dans votre enregistrement de connexion, le client tentera de le découvrir automatiquement, mais cela ajoute un aller-retour. Conservez toujours l'orgid après le premier appel réussi pour éviter des recherches répétées. ^[3]
• Jeton d'accès périmé : Si la logique de renouvellement du jeton n'est pas en place, les appels échoueront avec une erreur 401. Assurez-vous que votre client implémente un rappel tokenrefresher qui récupère le dernier refreshtoken depuis le stockage et l'échange contre un nouvel access_token. ^[3][4]
• Confusion entre GET et DELETE : Le même chemin (/api/v1/timetracking/settings) est utilisé pour les opérations GET, POST, PATCH et DELETE. Vérifiez bien la méthode HTTP avant d'exécuter — appeler accidentellement deletetimetrack_settings supprimera votre configuration. ^[5][1]

Ce qu'il faut vérifier

• L'authentification est valide : Vérifiez que accesstoken est présent dans votre enregistrement de connexion et que tokenexpires_at est dans le futur avant d'effectuer la requête. ^[4]
• orgid est renseigné : Confirmez que deskorgid est stocké et non vide dans votre table zohoconnections afin que le client Desk puisse l'ajouter aux en-têtes de la requête. ^[3]
• La réponse contient les clés attendues : Après avoir appelé gettimetrack_settings, vérifiez que le dictionnaire renvoyé n'est pas un objet d'erreur — une réponse réussie doit contenir les données de configuration du suivi du temps de votre portail plutôt qu'une clé error. ^[1]

---

*Beam Help est une ressource d'assistance experte indépendante pour les produits Zoho et ne constitue pas le support officiel de Zoho.*