Configuration

Créer un projet

Une fois votre client enregistré, vous pouvez commencer à créer votre propre application Android.

Dans votre ligne de commande, accédez au répertoire où vous voulez créer votre projet mobile et exécutez la commande suivante.

Vous serez invité à saisir les informations suivantes.

1. Nom de votre application mobile (Lead Approver, par exemple).
2. Nom de package Java souhaité de votre application mobile (com.zoho.test, par exemple).
3. ID client Zoho OAuth (obtenu lors de l'enregistrement de l'application).
4. Clé secrète du client Zoho OAuth (obtenue lors de l'enregistrement de l'application).
5. URL de redirection Zoho OAuth (obtenue lors de l'enregistrement de l'application).

Une fois la commande ci-dessus exécutée, un dossier de projet est créé dans le même répertoire. Le nom du dossier de projet est identique à celui de l'application mobile.

Exécuter le projet

Le nouveau projet est en fait une application Android de démonstration, qui peut être exécutée instantanément en utilisant Android Studio.

1. Ouvrez Android Studio.
2. Cliquez sur File (Fichier) > New (Nouveau) > Import Project (Importer un projet), choisissez le dossier du nouveau projet, puis cliquez sur Open (Ouvrir).
   La nouvelle application de démonstration s'ouvre en tant que projet Android.
3. Installez les dépendances manquantes comme recommandé par Gradle, le cas échéant.
4. Une fois le build de Gradle terminé, exécutez ce projet dans un émulateur.
   L'application s'ouvre avec un écran de connexion Zoho dans l'émulateur.
5. Connectez-vous avec vos informations d'identification Zoho CRM et affichez vos données avec l'application de démonstration.

Étendre l'application

Une fois votre projet développé et exécuté, vous pouvez concevoir et créer de nouveaux écrans et de nouvelles fonctionnalités pour votre application, selon vos besoins. Le développement de votre application n'applique aucune restriction frontale. Cependant, pour faciliter l'authentification de l'utilisateur, veillez à noter les points suivants lors de la conception de votre application.

Gestion de la connexion/déconnexion :

1. Pour gérer correctement la connexion de l'utilisateur, l'activité de lancement est déjà configurée dans le SDK pour s'assurer que seuls les utilisateurs connectés peuvent afficher les données des applications.
   • Toutefois, si vous voulez afficher votre propre écran de connexion personnalisé, associez votre package de classe de connexion personnalisé à customLoginActivityClass dans app_configuration.properties. Nous lançons votre customLoginClass comme activité de lanceur. Il est inutile de mentionner cette classe comme lanceur dans votre manifeste. Pour en assurer le bon fonctionnement, veillez à démarrer l'intention ZCRMLoginActivity à partir de votre activité de lancement personnalisée, afin d'initier le processus de connexion.
   • Lors de l'écriture d'une activité de lancement personnalisée, veillez à ne pas passer d'appel à Zoho CRM, sans invoquer ZCRMLoginActivity.
2. Pour gérer la déconnexion utilisateur, l'activité qui vous permet de gérer l'appel onClick de votre bouton de déconnexion doit étendre l'activité ZCRMBaseActivity et sa méthode onClick doit appeler super.logout().

Dans le fichier app_configuration.properties :

1. mainActivityClass (obligatoire) : indiquez votre package de classe principal (classe commençant après l'activité de connexion)
2. oauthScopes (obligatoire) : des exemples de portées sont déjà mentionnés dans le fichier de propriétés créé. Vous pouvez modifier les portées selon vos besoins. En savoir plus
3. accessType (facultatif) : type d'environnement dans CRM
   • Production : environnement disposant d'utilisateurs payants actifs qui accèdent aux données d'entreprise critiques.
   • Développement : environnements où vous pouvez étendre, intégrer et développer des solutions sans affecter vos environnements de production.
   • SandBox : environnements spécifiquement utilisés pour tester les fonctionnalités d'une application avant la phase de production ou sa publication.
4. minLogLevel (facultatif) : mentionnez votre niveau de journalisation préféré ici (ALL  [TOUS], FINEST  [OPTIMAL], TRACE  [SUIVI], DEBUG  [DÉBOGAGE], CONFIG  [CONFIGURATION], INFO  [INFORMATIONS], WARNING  [AVERTISSEMENT], ERROR  [ERREUR], OFF [DÉSACTIVÉ]).
5. domainSuffix (facultatif) : prise en charge multi-DC.
   • us - www.zohoapis.com
   • eu - www.zohoapis.eu
   • cn - www.zohoapis.com.cn
6. portalID (facultatif) : indiquez votre ID de portail CRM (65468393, par exemple). Il n'est pas utile de mentionner un ID de portail dans le fichier de propriétés si vous n'avez pas d'élément « portalID ».
7. showSignUp (facultatif) : définissez la valeur sur  true  si vous fournissez une fonction d'inscription dans votre application. Sinon, définissez la valeur sur  false.
8. customLoginActivityClass (facultatif) : indiquez votre package de classe d'activité de lanceur. Dans cette classe de lanceur, vous pouvez personnaliser votre identifiant en démarrant l'intention de classe de ZCRMLoginActivity.

Ce fichier contient les valeurs de certaines configurations nécessaires pour exécuter l'application. Merci de ne pas modifier les valeurs ou noms de propriété existant(e)s, ceux-ci étant nécessaires au bon fonctionnement du SDK et de l'application.

Le fichier est disponible au chemin suivant :
project home > app > src > main > assets > app_configuration.properties.

Vous pouvez également ajouter vos propres propriétés et valeurs, le cas échéant. Le fait d'appeler ZCRMSDKConfigUtil.getConfigValue(propertyName); dans n'importe quelle partie de votre code Java après le démarrage de l'application vous donne les valeurs des propriétés que vous ajoutez à ce fichier.

Wrappers d'API Zoho CRM

Pour faciliter l'accès aux données par le biais d'API Rest Zoho CRM, les SDK d'API intégrés pour Zoho CRM doivent être utilisés pour accéder aux données CRM via des API. Cette couche s'occupe de votre authentification d'API (génération et actualisation des jetons d'accès OAuth), de votre réponse d'API et de vos structures de demande. Elle renvoie des objets Java contenant les réponses d'API.

Par conséquent, un appel d'API ne représente qu'un appel de méthode pour l'application client.

Veuillez consulter la section Hiérarchie des classes de la documentation SDK Java de Zoho CRM.

Wrappers d'accès aux données SDK

En plus du conditionnement ci-dessus des API Zoho CRM, afin d'éviter tout appel d'API inutile, les métadonnées de module essentielles sont mises en cache par le SDK dans la mémoire de stockage local de l'appareil.

Actuellement, les données CRM (enregistrements) ne sont pas mises en cache. Seules les métadonnées de modules, tels que les dispositions, les sections, les champs et les détails de vue personnalisée, sont mises en cache.

ZCRMCachedModule

Certaines métadonnées supplémentaires sont mises en cache avec ZCRMCachedModule. Cela étend la classe ZCRMModule de la bibliothèque de client d'API Zoho CRM. Cette classe fournit les méthodes suivantes.

• getLayouts : renvoie toutes les dispositions du module en tant qu'objet BulkAPIResponse.
• getCustomViews : renvoie tous les détails de la vue personnalisée du module en tant qu'objet BulkAPIResponse.

Actualisation du cache

ZCRMCachedModule stocke et utilise les informations sur les métadonnées des modules et des présentations de formulaire mis en cache dans la mémoire de stockage local de l'appareil. Le SDK actualise les métadonnées stockées d'un module toutes les 12 heures.

Dans le cas où vous voulez forcer le SDK à vider le cache (exemple : si vous avez l'intention de faire quelque chose comme un balayage pour actualiser votre application) et à actualiser les métadonnées par le biais d'un appel d'API Zoho CRM, vous pouvez forcer cette opération en définissant l'indicateur refreshCache fourni dans les versions surchargées des méthodes ci-dessus. Un exemple d'appel est donné ci-dessous.