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é.
Modifications dans l'API version 1.0 - Conformité au RGPD
Qu'est-ce que le RGPD ?
Le RGPD est un ensemble complet de règles qui remplaceront l'actuelle Directive de protection des données (Directive 95/46/CE) et s'appliqueront dans toute l'UE. Il est conçu pour permettre aux résidents de l'UE de contrôler directement la manière dont ils souhaitent que leurs données soient traitées et de protéger la confidentialité de leurs données en raison de la nature de plus en plus complexe de la transmission des données personnelles à travers le monde.
Remarque :
- Le contenu présenté dans ce document ne doit pas être interprété comme un avis juridique. Contactez votre conseiller juridique pour connaître l'impact du RGPD sur votre organisation et ce que vous devez faire pour vous y conformer.
Nouveautés de l'API
Champs
Détails de la base de traitement de données
Le nouveau champ « Data Processing Basis Details (Détails de la base de traitement de données) » contiendra la base légale pour le traitement des données pour l'enregistrement en question. Vous pouvez déterminer les valeurs de ce champ selon la façon dont vous voulez traiter les données de votre client.
Actuellement, ce champ est pris en charge dans les modules Leads (Prospects), Contacts, Vendors (Fournisseurs) et les modules personnalisés uniquement.
Les valeurs du champ peuvent être :
Not Applicable (Non applicable), Legitimate Interests (Intérêts légitimes), Contract (Contrat), Legal Obligation (Obligation légale), Vital Interests (Intérêts vitaux), Public Interests (Intérêts publics), Consent-Pending (Consentement-En attente), Consent-Awaiting (Consentement-En instance), Consent-Obtained (Consentement-Obtenu), Consent-Not Respond (Consentement-Sans réponse), Stop Processing (Arrêt du traitement), Consent-Declined (Consentement-Refusé), Delete (Supprimer).
Remarque :
- Consent-Pending (Consentement-En attente) : le lien ou le formulaire de consentement n'est pas encore envoyé au client.
- Consent-Awaiting (Consentement-En instance) : le lien ou le formulaire de consentement est envoyé au client et attend une réponse.
- Consent-Obtained (Consentement-Obtenu) : le lien ou le formulaire de consentement est envoyé et le client a donné « l'accès » (il l'a accepté).
- Consent-Declined (Consentement-Refusé) : le formulaire de consentement est envoyé et le client a répondu par « Stop Processing » (Arrêt du traitement ».
Balises
Consentement
Cette nouvelle balise contient les détails du formulaire de consentement accepté par un client. Dans un autre sens, dans le cadre d'une demande, cette balise peut être utilisée pour ajouter des détails de consentement à un enregistrement particulier.
Attributs
Private (Privé)
Un attribut pour la balise de consentement, nommé « private » (privé) est ajouté aux API, afin de marquer le champ comme champ protégé. Le type de données de cette clé est booléen, c'est-à-dire vrai/faux.
Private Type (Type privé)
Un attribut pour la balise de consentement, nommé « private_type » est ajouté. Cette clé peut avoir la valeur « High » (Élevée), « Low » (Basse) ou « null » (nulle). Les valeurs « High » (Élevée) et « Low » (Basse) correspondent aux valeurs « Sensitive » (Sensible) et « Normal », comme dans l'interface CRM.
Arrêter le traitement
Lorsque la clé Arrêter le traitement d'un enregistrement particulier a la valeur « true », l'enregistrement passe alors en lecture seule. La valeur de cette clé est du type de données booléen (vrai ou faux).
Exemple :
<FL val="$stop_processing">true</FL>
Certains scénarios où cette clé revêt de l'importance :
- Un formulaire de consentement est envoyé au client qui fait une demande visant à arrêter temporairement sa demande. Une demande Arrêter le traitement sera alors envoyée.
- Un contrôleur de données, autrement dit un administrateur (PDG) d'une organisation, peut configurer son organisation de telle sorte que l'option Stop Processing (Arrêter le traitement) dans les paramètres de confidentialité soit activée lorsque l'étape de consentement a le statut « En attente » ou « En instance ».
API de champs
Les modifications apportées à l'API de champs sur la base de l'implémentation de la nouvelle politique de confidentialité sont les suivantes :
- L'attribut « private » indique si un champ est protégé (privé) ou non. Le type de données de la clé est booléen, c'est-à-dire vrai/faux.
- L'attribut « private_type » indique le niveau de sensibilité des données. Par exemple, si la sensibilité des données est élevée, private_type="High"
Remarque :
- Pour les champs non privés, c'est-à-dire, si "private=false", alors private_type="null".
- Les champs privés ne peuvent pas faire l'objet d'une recherche par critères.
URL : {module}/getFields, {module}/getAllFields
Exemple de réponse
<FL id="111111000000000861" req="false" type="Lookup" isreadonly="false" private="false" private_type="null" export="false" isQcreate="false" maxlength="120" label="Lead Owner" dv="Lead Owner" colName="SMOWNERID" ></FL>
<FL id="111111000000000863" req="true" type="Text" isreadonly="false" private="true" private_type="High" export="false" isQcreate="true" maxlength="100" label="Company" dv="Company" colName="COMPANY" ></FL>
<FL id="111111000000000871" req="false" type="Text" isreadonly="false" private="true" private_type="High" export="false" isQcreate="false" maxlength="100" label="Designation" dv="Title" colName="DESIGNATION" ></FL>
<FL id="111111000000000873" req="false" type="Email" isreadonly="false" private="true" private_type="Low" export="false" isQcreate="true" maxlength="100" label="Email" dv="Email" colName="EMAIL" ></FL>
API d'insertion
La nouvelle balise « Consent » (Consentement) contient les détails du formulaire de consentement accepté par un client. Dans un autre sens, dans le cadre d'une demande, cette balise peut être utilisée pour ajouter des détails de consentement à un enregistrement particulier.
Les modifications apportées à l'API d'insertion sur la base de l'implémentation de la nouvelle politique de confidentialité sont les suivantes :
- CONSENTID ne peut pas être fourni dans les données d'entrée (le consentement existant ne peut pas être associé)
- L'e-mail ne peut pas être fourni dans le consentement (dans <consent></consent>)
- L'API d'insertion ne générera pas d'erreur pour l'ID de messagerie Arrêt du traitement. Au lieu de cela, l'enregistrement sera créé avec l'ID de messagerie stop-processing et sera déplacé vers Arrêter le traitement.
- Si une adresse e-mail non valide est fournie dans l'enregistrement (dans <row></row>), elle sera validée.
Remarque :
Les cas d'utilisation mentionnés ci-dessus s'appliquent uniquement si
- La fonctionnalité Paramètres de conformité est activée pour l'organisation (par Zoho).
- La conformité au RGPD est activée par l'utilisateur.
- Le module en cours d'accès doit être un module de confidentialité des données (il peut être choisi par l'utilisateur via l'option Manage data privacy for module (Gérer la confidentialité des données pour le module).
Exemple d'entrée
<Leads>
<row no="1">
<FL val="Last Name">Patricia</FL>
<FL val="Email">p.boyle@zylker.com</FL>
<FL val="Data Processing Basis Details">
<consent>
<FL val="Contact through Email">true</FL>
<FL val="Contact Through Phone">false</FL>
<FL val="Contact Through Survey">false</FL>
<FL val="Contact Through Social Handles">false</FL>
<FL val="Consent Through">Email</FL>
<FL val="Consent Date">2018-04-27</FL>
<FL val="Allow Other Service">true</FL>
<FL val="Consent Remarks">Consent approved by customer</FL>
<FL val="Data Processing Basis">Obtained</FL>
</consent>
</FL>
</row>
</Leads>
API de mise à jour
Les modifications apportées à l'API de mise à jour sur la base de l'implémentation de la nouvelle politique de confidentialité sont les suivantes :
- CONSENTID ne peut pas être fourni dans les données d'entrée (le consentement existant ne peut être associé).
- L'e-mail ne peut pas être fourni dans le consentement (dans <consent></consent>)
- Si une adresse e-mail non valide est fournie dans l'enregistrement (dans <row></row>), elle sera validée.
Remarque :
Les cas d'utilisation mentionnés ci-dessus s'appliquent uniquement si
- La fonctionnalité Paramètres de conformité est activée pour l'organisation (par Zoho).
- La conformité au RGPD est activée par l'utilisateur.
- Le module en cours d'accès doit être un module de confidentialité des données (il peut être choisi par l'utilisateur via l'option Manage data privacy for module (Gérer la confidentialité des données pour le module).
Exemple d'entrée
<Leads>
<row no="1">
<FL val="Last Name">Patricia</FL>
<FL val="Email">p.boyle@zylker.com</FL>
<FL val="Data Processing Basis Details">
<consent>
<FL val="Contact through Email">true</FL>
<FL val="Contact Through Phone">false</FL>
<FL val="Contact Through Survey">false</FL>
<FL val="Contact Through Social Handles">false</FL>
<FL val="Consent Through">Email</FL>
<FL val="Consent Date">2018-04-27</FL>
<FL val="Allow Other Service">true</FL>
<FL val="Consent Remarks">Consent approved by customer</FL>
<FL val="Data Processing Basis">Obtained</FL>
</consent>
</FL>
</row>
</Leads>
API Get
Les modifications apportées à l'API Get (getRecords/getRecordById/getRelatedRecords/searchRecords/searchRecordsByPDC/getSearchRecords) sur la base de l'implémentation de la nouvelle politique de confidentialité sont les suivantes :
- Lorsque include_pi_fields=true est spécifié, les champs privés du module seront fournis dans les enregistrements GET API.
- La clé $stop_processing fournie dans toutes les réponses GET API
Remarque :
Les cas d'utilisation mentionnés ci-dessus s'appliquent uniquement si
- La fonctionnalité Paramètres de conformité est activée pour l'organisation (par Zoho).
- La conformité au RGPD est activée par l'utilisateur.
- Le module en cours d'accès doit être un module de confidentialité des données (il peut être choisi par l'utilisateur via l'option Manage data privacy for module (Gérer la confidentialité des données pour le module).
Exemple de réponse
<response uri="/crm/private/xml/Leads/getRecords">
<pi_fields>
<FL id="111111000000000863" label="Company" private="true" private_type="High" export="false"></FL>
<FL id="111111000000000873" label="Email" private="true" private_type="Low" export="false"></FL>
<FL id="111111000000000875" label="Phone" private="true" private_type="High" export="false"></FL>
<FL id="111111000000000877" label="Fax" private="true" private_type="High" export="false"></FL>
</pi_fields>
<result>
<Leads>
<row no="1">
<FL val="LEADID">111111000000056343</FL>
<FL val="$stop_processing">false</FL>
<FL val="SMOWNERID">111111000000031431</FL>
...
</row>
</Leads>
</result>
</response>
Réponses avec détails de la base de traitement de données :
Exemple de réponse
<FL val="Data Processing Basis Details">
<consent>
<FL val="CONSENTID">111111000000032361</FL>
<FL val="Contact through Email">true</FL>
<FL val="Contact Through Phone">false</FL>
<FL val="Contact Through Survey">false</FL>
<FL val="Contact Through Social Handles">false</FL>
<FL val="Email">null</FL>
<FL val="SMCREATORID">111111000000031431</FL>
<FL val="Created By">Boyle GDPR</FL>
<FL val="MODIFIEDBY">111111000000031431</FL>
<FL val="Modified By">Boyle GDPR</FL>
<FL val="SMOWNERID">111111000000031431</FL>
<FL val="Consent Owner">Boyle GDPR</FL>
<FL val="Created Time">2018-04-26 20:33:34</FL>
<FL val="Modified Time">2018-04-26 20:33:34</FL>
<FL val="Consent Through">Email</FL>
<FL val="Consent Date">2018-04-27</FL>
<FL val="Consent Ends On">null</FL>
<FL val="Allow Other Service">false</FL>
<FL val="Consent Remarks">Consent accepted by the customer.</FL>
<FL val="Data Processing Basis">Obtained</FL>
<FL val="Mail Sent Time">null</FL>
<FL val="Consent Lawful Details">null</FL>
<FL val="Consent Other Details">null</FL>
</consent>
</FL>
API de recherche d'enregistrements
Les champs marqués comme privés NE PEUVENT PAS être obtenus par les critères de recherche, searchCondition, searchColumn et customview. Si un champ privé est soumis à une recherche, la réponse suivante sera affichée.
Exemple de réponse
<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Leads/searchRecords">
<error>
<code>4899</code>
<message>API call cannot be completed as private field given in criteria/searchCondition/searchColumn/customview</message>
</error>
</response>
Messages d'erreur
Le message d'erreur suivant est affiché pour les API d'insertion d'enregistrements, de mise à jour, upsert, convertLead et sendMail.
Exemple de réponse
<response uri="/crm/private/xml/Leads/convertLead">
<error>
<code>4202</code>
<message>API call cannot be completed as the record is in stop processing</message>
</error>
</response>
Remarque :
Blocked (Bloqué) : le statut Blocked peut être ajouté à un enregistrement et utilisé pour bloquer, ou verrouiller, un enregistrement particulier en configurant le champ « Email »" en tant que champ d'identification. En d'autres termes, si un enregistrement contenant un e-mail particulier est bloqué, les enregistrements contenant le même e-mail ne peuvent pas être ajoutés ou mis à jour.