Auparavant, dans notre série de blogs Vtiger Application Platform (VTAP), nous avons expliqué comment personnaliser l'interface Vtiger et intégrer des boutons et des widgets personnalisés pour répondre aux besoins spécifiques de l'entreprise. Ce n'est qu'une des fonctionnalités offertes par la plate-forme.
VTAP vous offre de nombreuses fonctionnalités qui vous aident à :
- Créer une API REST personnalisée
- Connectez-vous à d'autres applications pour lesquelles l'API REST est disponible
- Se connecter aux applications compatibles OAuth
Dans ce blog, je vais discuter de la façon dont nous pouvons créer une API REST personnalisée.
Tout d'abord, permettez-moi de parler un peu des API Vtiger REST. Il est accessible avec le point de terminaison ci-dessous, qui sera spécifique à votre instance CRM.
Par exemple,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default
Si vous connaissez le Vtiger API REST, vous pouvez ignorer la section ci-dessous. Pour connaître les modules accessibles, vous pouvez utiliser le types de liste API.
Voici une capture d'écran de la façon dont vous pouvez accéder à l'API à l'aide du client postman.
Vtiger fournit déjà un ensemble standard d'API, mais avec le nouvel outil API Designer, vous pouvez désormais écrire vos propres API REST personnalisées.
Concepteur d'API
Le concepteur d'API fournit un plan de travail aux développeurs pour développer des API basées sur HTTP qui peuvent être exposées aux API Javascript VTAP ou à l'application externe pour une intégration facile. Les API peuvent être définies en utilisant VADL cahier des charges.
L'accès à l'API nécessite l'autorisation de l'utilisateur et suit la configuration standard d'accès aux enregistrements effectuée dans le CRM.
Le concepteur d'API fournit un IDE pour écrire des API personnalisées. Si vous écrivez une API REST personnalisée pour un module particulier, vous devez nommer l'API et sélectionner le module.
Nous avons défini le langage de définition d'application Vtiger (VADL), qui est basé sur la syntaxe XML pour permettre aux administrateurs ou aux développeurs novices de définir l'API sans expertise en programmation.
VADL vous permet de:
- Définir le CURD
- API (Créer, Mettre à jour, Récupérer, Supprimer) sur les modules d'entité
- Appeler un point de terminaison basé sur HTTP (REST / SOAP) via des méthodes (GET/POST/PUT/DELETE)
- Avec authentification (Basic / Bearer token-based)
- Accepter les paramètres de demande et lier en tant qu'entrées API
Prenons un exemple de création d'une API REST personnalisée qui recherchera les contacts correspondant au domaine de messagerie. Nous allons ajouter une nouvelle API avec le nom 'fetch_email_contact' et sélectionner le module Contacts
Toutes les définitions sont placées dans un API nœud avec le type HTTP standard (get, post, put et delete). Étant donné que nous récupérons les données du CRM, nous utiliserons sélectionner des nœuds et transmettre les noms de modules. Nous aurons des champs qui doivent être récupérés à l'intérieur du nœud d'enregistrements et toutes les conditions de filtre à l'intérieur du De nœud. Nous prenons en charge différents types de conditions comme égal, pas égal, comme, supérieur à, inférieur à, etc.
Ci-dessus est un exemple simple, qui peut également être réalisé en utilisant l'existant question API REST. La vraie puissance devient évidente lorsque vous combinez plusieurs API en une seule.
Considérez cet exemple. Vous mettez à jour un enregistrement s'il existe ou en créez un s'il n'existe pas. Si vous utilisez une API existante, plusieurs appels seront nécessaires pour effectuer ces opérations. Mais lorsque vous utilisez le concepteur d'API, vous pouvez combiner ces opérations en un seul appel d'API.
Dans l'exemple ci-dessus, nous plaçons la définition à l'intérieur du bouleverser nœud. Cela comprend le Mise à jour ainsi que engendrent node, qui mettra à jour un enregistrement s'il existe ou créera un enregistrement s'il n'existe pas. Pour identifier l'enregistrement qui doit être mis à jour, vous pouvez utiliser où filtrer et rechercher les entrées pertinentes. À la fin de la définition, le nœud de retour renverra les champs définis au client.
Vous pouvez enregistrer et publier ces API pour les rendre disponibles pour les applications externes ainsi que pour le Javascript VTAP interne.
Accéder à une API personnalisée publiée via API Designer
- Pour accéder à toute API personnalisée publiée via API Designer, vous devrez utiliser le point de terminaison ci-dessous.
- https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME?PARAMÈTRES
- API_NAME doit être remplacé par le nom donné à l'API. Assurez-vous également que vous utilisez le type HTTP approprié et Lettres de créance(nom d'utilisateur et clé d'accès) pour y accéder.
Accéder à un fichier récemment créé récupérer_email_contact API utilisant le facteur
- Pour accéder à un fichier récemment créé récupérer_email_contact API utilisant postman, vous devez utiliser ce qui suit.
- https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%
Notes : https://votre_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% est obsolète.
Ces API sont accessibles en interne dans Module Designer à l'aide de l'API Javascript VTAP VTAP.CustomApi.Get à afficher dans un widget ou des pages personnalisées dans l'interface utilisateur de Vtiger.
Pour conclure, nous avons vu comment l'outil API Designer vous permet d'écrire des API REST personnalisées et de les utiliser en interne et dans d'autres applications pour consommer les données CRM de manière transparente.
Pour toute autre question, merci d'envoyer un mail à [email protected]. Inscrivez-vous à l'édition développeur ici.
