FAQ : Centre des développeurs

FAQ : Centre des développeurs

Cette page a été traduite à l'aide d'outils d'IA et peut contenir des erreurs. Pour les informations les plus précises et à jour, consultez la version anglaise originale.

Comment puis-je extraire les données du module Leads vers mon application à l'aide d'une API ?

Vous pouvez utiliser l'API REST Zoho CRM pour extraire les données du module Leads et d'autres modules. Reportez-vous à ce document pour plus de détails.

La clé API est-elle spécifique à l'utilisateur ou à l'organisation ?

La clé API Zoho CRM est spécifique à l'organisation. Vous pouvez utiliser la même clé API pour tous les utilisateurs avec des identifiants de ticket différents (spécifiques à l'utilisateur).

Quel est le format du paramètre xmlData pour associer un Task ou un événement aux enregistrements CRM ?

Utilisez l'exemple XML suivant pour associer un événement respectivement au compte et au contact.

Compte

<Events><row
no="1">
<FL val="SEMODULE">Accounts</FL>
<FL val="SEID">22222222222</FL>
<FL val="Subject">test</FL>
<FL val="Start DateTime">12/12/2009
11:12:25</FL>
<FL val="End
DateTime">12/12/2009 11:12:25</FL>
</row>
</Events>

Contact

<Events><row
no="1&">
<FL val="SEMODULE">Contacts</FL>
<FL val="CONTACTID">22222222222</FL>
<FL val="Subject">test</FL>
<FL val="Start DateTime">12/12/2009
11:12:25</FL>
<FL val="End
DateTime">12/12/2009 11:12:25</FL>
</row>
</Events>


Puis-je déclencher un e-mail après l'insertion d'un lead via l'API ?

Oui, vous pouvez faire cela en créant un workflow pour envoyer des e-mails automatisés lorsque des leads arrivent dans CRM. Lorsque vous appelez l'API pour insérer des Leads, veuillez ajouter le paramètre « wfTrigger » avec la valeur « true ». En savoir plus sur les paramètres d'insertion d'enregistrement.
Cela déclenchera le workflow après l'insertion de l'enregistrement, qui enverra ensuite l'e-mail.

Comment récupérer un seul compte à l'aide de getAllRecords ?

Vous pouvez récupérer un seul compte à l'aide de la méthode getRecordById en transmettant l'identifiant de l'enregistrement.

Comment assigner un nouveau lead à un propriétaire lors de l'insertion du lead via l'API ?

Lors de l'insertion d'un lead via l'API, assurez-vous que vous spécifiez l'adresse e-mail du propriétaire du lead. Si vous utilisez le nom du propriétaire du lead ou son identifiant utilisateur, le lead sera assigné à l'identifiant de connexion par défaut utilisé lors de la génération du ticket.

Si j'utilise l'édition Enterprise et que je me suis abonné pour 2 utilisateurs supplémentaires, combien de requêtes API puis-je faire par jour ?

Dans Zoho CRM, un seul utilisateur de l'édition Enterprise peut faire un maximum de 25 000 requêtes par jour par organisation ou 500 utilisateurs par licence utilisateur, selon la valeur la plus faible.
Les limites minimales et maximales varient selon l'édition que l'organisation utilise actuellement.

En savoir plus sur les limites de l'API ici

Est-il possible de télécharger et d'associer une pièce jointe à un enregistrement via l'API Zoho CRM ?

Oui. Il est possible d'associer une pièce jointe à un enregistrement via l'API Zoho CRM, en utilisant la méthode uploadFile pour joindre des fichiers aux enregistrements.

Voir aussi : Méthode uploadFile

Que se passe-t-il si je ne spécifie pas de valeur pour le paramètre newFormat lors de la récupération des enregistrements ?

La valeur par défaut « 1 » sera assignée au paramètre newFormat s'il n'est pas spécifié lors de la récupération des enregistrements, c'est-à-dire newFormat = 1.


Est-il possible d'insérer des enregistrements via HTTP post ?

Non. Les enregistrements peuvent uniquement être insérés via XML post. Pour plus de détails, reportez-vous à ce lien.

Pour la méthode updateRecords, où puis-je obtenir la valeur de l'identifiant d'enregistrement ?

La valeur de l'identifiant d'enregistrement unique sera disponible dans la réponse XML obtenue après l'insertion ou la récupération des enregistrements.
 
Par exemple : <FL val="Id">508020000016189251</FL


Qu'est-ce qu'un jeton d'authentification CRM ?

Le jeton d'authentification CRM est une chaîne alphanumérique chiffrée requise pour authentifier vos identifiants Zoho CRM. Il est utilisé pour intégrer votre compte CRM avec des logiciels et des services tiers.

Puis-je générer un nouveau jeton d'authentification ?

Oui. Il existe deux façons de générer un nouveau jeton d'authentification.

1. La première méthode est le mode API. Vous pouvez utiliser le même format d'URL que celui utilisé pour générer le précédent. Le format d'URL est :

https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCRM/crmapi&EMAIL_ID=[Username/EmailID]&PASSWORD=[Password]&DISPLAY_NAME=[ApplicationName]

2. La deuxième méthode est le mode navigateur. Pour utiliser cette méthode :
  • Cliquez sur Configuration > Developer Hub > APIs & SDKs
  • Sur la page CRM API, cliquez sur Paramètres et sélectionnez Génération du jeton d'authentification. Cliquez sur le bouton Générer pour obtenir le jeton d'authentification immédiatement.


Veuillez noter que le jeton d'authentification existant restera également valide.

Comment supprimer un jeton d'authentification existant ?

Pour supprimer un jeton d'authentification existant :
  1. Connectez-vous à accounts.zoho.com.
  2. Cliquez sur Mes informations de profil.
  3. Accédez à Sessions et cliquez sur Jetons d'authentification actifs.
  4. Tous les jetons d'authentification générés seront répertoriés ici.
  5. Cochez la ou les cases des jetons d'authentification à supprimer et cliquez sur Supprimer la sélection. Le jeton d'authentification sera supprimé.
Pour plus d'informations sur le jeton d'authentification, cliquez sur ici.

J'insère un lead à l'aide de la méthode insertRecords, mais la règle de workflow associée n'est pas déclenchée. Pourquoi ?

Pour que la règle de workflow soit déclenchée, vous devez affecter la valeur true au paramètre wfTrigger. Par défaut, ce paramètre est défini sur false.

Que se passera-t-il si j'ai dépassé ma limite d'API pour la journée ?

Si vous avez dépassé votre limite d'API pour la journée, Zoho CRM ne répondra pas aux appels API pour le reste de la journée. Vous devez attendre que la limite d'API soit réinitialisée pour le jour suivant. Les limites d'API sont réinitialisées chaque jour entre 0 h et 3 h du matin PST.

Si la limite d'API actuelle ne correspond pas à vos besoins métier, vous pouvez augmenter la limite d'API par jour. Pour en savoir plus sur les détails de tarification pour augmenter les limites d'appels API, veuillez envoyer un email à support@zohocrm.com 

Pour optimiser votre utilisation de l'API, récupérez un maximum de 200 enregistrements à chaque requête et insérez, mettez à jour ou supprimez un maximum de 100 enregistrements à chaque requête.

Remarque : Dans toutes les éditions de Zoho CRM, les méthodes getSearchRecords et getCVRecords ont une limite standard de 250 appels API par jour.

Puis-je augmenter la limite d'API ?

Oui. Si la limite d'API actuelle ne correspond pas à vos besoins métier, vous pouvez augmenter votre limite d'API par jour. Il vous suffit de nous envoyer un email à support@zohocrm.com en indiquant vos besoins et nous vous transmettrons les détails de tarification pour augmenter les limites d'appels API.

Est-il possible d'utiliser la méthode getRelatedRecords pour les champs de recherche personnalisés ?

Non, vous ne pouvez pas utiliser la méthode getRelatedRecords pour les champs de recherche personnalisés. Il est possible d'utiliser cette méthode pour récupérer les enregistrements associés aux éléments définis par le système.

Par exemple : vous pouvez récupérer les Task/Événements/Appels associés à un Compte, un Contact, etc.

Voir aussi : Méthodes API

Tout le monde dans une entreprise peut-il utiliser la même clé API ?

Oui, tous les membres de votre entreprise peuvent utiliser la même clé API pour le développement et l'intégration d'applications tierces.


Quel est le format du paramètre xmlData pour les méthodes insertRecords et updateRecords ?

Utilisez les paramètres XMLData suivants lors de l'utilisation des méthodes insertRecords et updateRecords :

insertRecords : https:// crm.zoho.com/crm/private/ xml / Leads /insertRecords?apikey= API Key &ticket= Ticket
  1. ticket=xxxxxxxxxxxxxx
  2. apikey=xxxxxxxxxxxxxx
  3. xmlData= comme indiqué ci-dessous
  1. <Leads>
    <row no="1">
    <     FL val ="Lead Source">Web Download</FL>
    <     FL val ="First Name">contacto 1</FL>
    <     FL val ="Last Name">apellido</FL>
    < FL val ="Email"> testing@testing.com < /FL >
    <     FL val ="Title">Manager</FL>
    <     FL val ="Phone">1234567890</FL>
    <     FL val ="Home Phone">0987654321</FL>
    <     FL val ="Other Phone">1212211212</FL>
    <     FL val ="Fax">02927272626</FL>
    <     FL val ="Mobile">292827622</FL>
    </row>
    </Leads>
updateRecords: https://crm.zoho.com/crm/private/xml/Leads/updateRecords?apikey=Clé API&ticket=Ticket
  • ticket=xxxxxxxxxxxxxxx
  • apikey=xxxxxxxxxxxxxxx
  • id = 1000000019001
  • xmlData= comme indiqué ci-dessous
  1. <Leads>
    <row no="1">
    <    FL val="Lead Source">Web Download</FL>
    <    FL val="First Name">contacto 1</FL>
    <    FL val="Last Name">apellido</FL>
    <FL val="Email">testing@testing.com</FL>
    <    FL val="Title">Manager</FL>
    <    FL val="Phone">1234567890</FL>
    <    FL val="Home Phone">0987654321</FL>
    <    FL val="Other Phone">1212211212</FL>
    <    FL val="Fax">02927272626</FL>
    <    FL val="Mobile">292827622</FL>
    </row>
    </Leads>

Est-il nécessaire d'envoyer tous les paramètres en POST ?

Oui, vous devez envoyer tous les paramètres en POST.


Quel est le format du paramètre xmlData pour associer une Task ou un événement aux enregistrements CRM ?

Utilisez l'exemple XML suivant pour associer un événement au compte et au contact respectivement.

  1. Accounts

    <Events><row no="1">
    < FL val =" SEMODULE "> Accounts </FL>
    < FL val ="SEID"> 22222222222 </FL>
    < FL val ="Subject">test</FL>
    < FL val ="Start DateTime">12/12/2009 11:12:25</FL>
    < FL val ="End DateTime">12/12/2009 11:12:25</FL>
    </row>
    </Events>

  2. Contacts

    <Events><row no="1&">
    < FL val = "SEMODULE "> Contacts </FL>
    < FL val = "CONTACTID "> 22222222222 </FL>
    < FL val ="Subject">test</FL>
    < FL val ="Start DateTime">12/12/2009 11:12:25</FL>
    < FL val ="End DateTime">12/12/2009 11:12:25</FL>
    </row>
    </Events>

Puis-je utiliser l'ID d'enregistrement lors de l'association d'un champ de recherche à un module ?

Oui, vous pouvez utiliser l'ID d'enregistrement lors de l'association d'un champ de recherche à des modules (Ex : association d'une campagne avec un lead ou d'un Account avec un Contact).

Si j'utilise la Free Edition, combien de requêtes API puis-je effectuer par jour ?

Dans la Free Edition, vous pouvez effectuer un maximum de 1000 requêtes/jour/organisation.

Que se passe-t-il si je ne spécifie pas de valeur pour le paramètre newFormat lors de la récupération d'enregistrements ?

La valeur par défaut « 1 » sera assignée au paramètre newFormat s'il n'est pas spécifié lors de la récupération d'enregistrements, c.-à-d. newFormat = 1.


Puis-je associer un compte ou un contact lors de la création d'une Task via une API ?

Oui, vous pouvez associer une Task créée via une API avec un compte ou un contact. Voici l'exemple XML pour associer une Task avec un compte ou un contact :
 
<Tasks>
<row no='1'>
<FL val='Subject'>test 11111111</FL>
<FL val='Due Date'>20/2/2021</FL>
<FL val='CONTACTID'>xxxxxxxxxx</FL>
<FL val='SEMODULE'>Accounts</FL>
<FL val='SEID'>xxxxxxxxx</FL>
</row>
</Tasks>