La récupération de toutes les pièces jointes liées à un enregistrement de produit spécifique dans Zoho Desk nécessite une seule requête GET authentifiée vers le point de terminaison des pièces jointes des produits — voici exactement comment procéder.
Pourquoi c'est important
Lors de la gestion d'un catalogue de produits dans Zoho Desk, les agents et les développeurs ont souvent besoin d'auditer ou d'afficher chaque fichier associé à un produit — fiches techniques, documents de garantie ou images, par exemple. Automatiser cette récupération fait gagner du temps par rapport à la navigation dans l'interface utilisateur et est essentiel pour les intégrations qui synchronisent les ressources produit avec des systèmes externes. Connaître le bon point de terminaison et les bons paramètres dès le départ évite de perdre du temps en débogage.
> Beam Help est un service d'assistance expert indépendant pour Zoho — nous ne sommes pas le support officiel de Zoho.
---
Étape par étape
Étape 1. Vérifiez que vos scopes OAuth sont en place.
Avant d'effectuer tout appel API, vérifiez que votre jeton OAuth inclut les scopes Zoho Desk nécessaires. Vous aurez au minimum besoin du scope Desk.settings.READ ou d'un scope plus large Desk.settings.ALL, ainsi que de Desk.basic.READ pour l'accès organisationnel. Sans ces scopes, l'API retournera une erreur d'autorisation. [7]
Étape 2. Identifiez l'identifiant du produit cible.
Vous avez besoin du productId unique du produit dont vous souhaitez lister les pièces jointes. Cet identifiant est généralement visible dans le panneau d'administration de Zoho Desk, dans la section Produits, ou vous pouvez le récupérer par programmation à partir d'un appel préalable à la liste des produits. Gardez cette valeur à portée de main — elle fait partie du chemin de la requête. [1]
Étape 3. Construisez la requête GET.
Envoyez une requête HTTP GET vers le point de terminaison suivant, en remplaçant l'identifiant réel de votre produit :
GET /api/v1/products/{productId}/attachments
Le point de terminaison accepte deux paramètres :
| Paramètre | Type | Description |
|---|---|---|
| productId | string (chemin) | L'identifiant unique de l'enregistrement produit |
| p | dict / paramètres de requête | Paramètres optionnels de pagination ou de filtrage |
Étape 4. Effectuez l'appel avec le client Python (le cas échéant).
Si vous travaillez avec un client Zoho Desk basé sur Python, la signature de la méthode ressemble à ceci :
def list_all_attachments(self, productId: str, p: dict = None):
return self.c.request("GET", f"/api/v1/products/{productId}/attachments", p, None)
Passez l'identifiant du produit sous forme de chaîne de caractères et, optionnellement, un dictionnaire de paramètres de requête comme second argument. Lorsque p est omis ou défini sur None, l'API retourne la liste des pièces jointes par défaut sans filtrage supplémentaire. [1]
Étape 5. Analysez la réponse.
Une réponse réussie contiendra la liste des objets de pièces jointes pour ce produit. Chaque objet inclut généralement des métadonnées telles que le nom du fichier, sa taille et un identifiant de référence. Parcourez la collection retournée pour afficher, télécharger ou traiter chaque pièce jointe selon votre cas d'usage. [1]
Étape 6. Gérez la pagination si nécessaire.
Le paramètre p prend en charge les contrôles de pagination. Si le produit possède un grand nombre de pièces jointes, passez les valeurs de page ou de décalage appropriées dans le dictionnaire p pour récupérer les pages de résultats suivantes. [1]
---
Erreurs courantes
- Scopes OAuth manquants ou insuffisants. La configuration OAuth de Zoho Desk nécessite des déclarations de scopes explicites. Si votre jeton a été généré sans les scopes
Desk.settingsouDesk.basicpertinents, les requêtes échoueront avec une erreur de permissions. Vérifiez attentivement votre liste de scopes avant de déboguer le point de terminaison lui-même. [7]
- Format d'identifiant de produit incorrect. Le
productIddoit être passé sous forme de chaîne de caractères dans le chemin. Passer un entier ou un identifiant malformé entraînera une erreur 404 ou similaire. Validez toujours l'identifiant par rapport à un enregistrement de produit connu au préalable. [1]
- Confusion entre les pièces jointes de produit et les pièces jointes de ticket. Zoho Desk dispose de points de terminaison distincts pour les tickets, les contacts et les produits. Assurez-vous d'appeler
/api/v1/products/{productId}/attachmentset non une route de pièces jointes au niveau des tickets — les deux ne sont pas interchangeables. [1]
---
Ce qu'il faut vérifier
- Validité du jeton OAuth : Confirmez que votre jeton d'accès n'a pas expiré et qu'il inclut les scopes Desk corrects avant d'effectuer la requête. [7]
- Exactitude de l'identifiant produit : Comparez le
productIdque vous utilisez avec le panneau d'administration de Zoho Desk pour vous assurer qu'il correspond bien à l'enregistrement produit souhaité. [1] - Pagination de la réponse : Si le nombre de pièces jointes retourné semble inférieur à ce qui est attendu, vérifiez si des pages supplémentaires existent en consultant les métadonnées de pagination dans la réponse et en effectuant une nouvelle requête avec le paramètre
p. [1]