La version 1.0 des API Zoho CRM est en fin de vie et sera obsolète le 31 décembre 2018. Nous vous recommandons de vérifier les nouvelles API 2.0 pour plus d'efficacité.
Utilisation d'un jeton d'authentification
Table des matières
L'API Zoho CRM est disponible dans toutes les éditions de Zoho CRM. Pour utiliser l'API, vous aurez besoin du jeton d'authentification Zoho CRM de votre compte CRM. Assurez-vous d'avoir l'autorisation d'accéder au service de l'API. Si vous n'avez pas l'autorisation, veuillez contacter votre administrateur CRM.
Générer un jeton d'authentification
Pour générer le jeton d'authentification, vous avez besoin d'envoyer une demande d'authentification à Zoho Accounts en utilisant le format d'URL ci-dessous. Assurez-vous que vous êtes un utilisateur confirmé, sans quoi vous risquez de recevoir un message d'erreur lors de la génération du jeton d'authentification : ACCOUNT_REGISTRATION_NOT_CONFIRMED (ENREGISTREMENT_DE_COMPTE_NON_CONFIRMÉ).
Format de l'URL
Mode API :
Pour générer un jeton d'authentification en mode API, procédez comme suit :
- Connectez-vous à Zoho CRM.
- Ouvrez https://accounts.zoho.com .
- Dans la page Zoho Accounts Home (Accueil Zoho Accounts), cliquez sur Two Factor Authentication (Authentification à deux facteurs).
- Dans la page Two Factor Authentication (Authentification à deux facteurs), cliquez sur Manage Application Specific Passwords (Gérer les mots de passe spécifiques à l'application).
- Dans la fenêtre contextuelle Application Specific Passwords (Mots de passe spécifiques à l'application), procédez comme suit :
- Entrez le nom de l'application ou de l'appareil.
- Entrez le mot de passe actuel.
- Cliquez sur Generate (Générer). Vous recevrez le nouveau mot de passe spécifique à l'application avec des espaces.
- Supprimez les espaces dans le mot de passe et incluez-le dans l'URL en mode API suivante pour générer le jeton d'authentification.
Remarque :
- Utilisez la méthode HTTP POST pour faire la demande.
Les paramètres à transmettre avec cette URL sont :
| Paramètre | Description |
| EMAIL_ID | Spécifiez votre ID de messagerie ou votre nom d'utilisateur Zoho CRM. |
| scope | Spécifiez la valeur comme ZohoCRM/crmapi. |
| PASSWORD | Indiquez votre mot de passe Zoho CRM. |
| DISPLAY_NAME | Spécifiez le nom de l'application qui décrit l'objet de l'utilisation de ce jeton d'authentification. Par exemple, « MailChimp » ou « Google Apps ». |
Pour plus d'informations, veuillez consulter la page d' aide de l'authentification à deux facteurs.
Exemple de réponse
Remarque :
- Le jeton d'authentification peut être utilisé dans tous vos appels d'API. Vous pouvez également voir le format de l'URL sous Setup (Configuration) > Developer Space (Espace développeur) > APIs (API).
- Vous devez être connecté à votre compte CRM pour utiliser le mode Navigateur.
Exemple
Voici un exemple de récupération d'enregistrements :
Révocation de jetons d'authentification
Vous pouvez supprimer le jeton d'authentification généré pour votre compte depuis la page My Zoho Account (Mon compte Zoho).
- Connectez-vous à Zoho CRM.
- Ouvrez [Username] (Nom d'utilisateur) > My Account (Mon compte).
- Dans votre page Accounts (Comptes), cliquez sur Active Authtokens (Jetons d'authentification actifs).
- Dans la page Active Authtokens (Jetons d'authentification actifs), vous pouvez supprimer (révoquer) des jetons d'authentification.
Remarque :
- Pour des raisons de sécurité, vous ne serez pas en mesure de voir les jetons d'authentification existants. Veuillez enregistrer le jeton d'authentification lorsqu'il est généré.
- Supprimer un jeton d'authentification supprime le jeton définitivement.
- Si vous générez de nouveau le jeton d'authentification, mettez à jour votre programme avec le nouveau jeton.
Points à retenir
- Le jeton d'authentification est spécifique à l'utilisateur et est un jeton permanent.
- En cas de suppression, le jeton existant est supprimé définitivement. Le nouveau jeton doit être remplacé dans tous les appels d'API.
- Le jeton d'authentification d'un compte utilisateur ne sera pas valable si l'utilisateur est désactivé.
- Nous informons les utilisateurs de CRM (utilisateurs qui ont généré le jeton d'authentification) si votre organisation dépasse la limite de l'API.
- Si votre application nécessite plus que la limite supérieure, vos requêtes API supplémentaires ne seront pas traitées. Pour éviter les problèmes de transfert de données, veuillez évaluer vos exigences API bien à l'avance. Si vous avez besoin d'aide, veuillez contacter notre support à l'adresse support@zohocrm.com