Passer au contenu
Accueil » Votre guide pour créer des API REST

Votre guide pour créer des API REST

API signifie Application Programming Interface. Tout logiciel doté d'une fonction spécifique est appelé une application lors de l'examen des API. Vous pouvez comparer l'interface API à un contrat de service entre deux programmes qui spécifient les demandes et les réponses. Si vous débutez avec les API, nous vous recommandons de consulter notre Guide du débutant sur les API et Présentation des API REST blog avant de lire celui-ci.

API REST vous permettent d'accéder aux données CRM via le protocole HTTP/HTTPS. Vous pouvez effectuer des actions telles que créer, mettre à jour, récupérer ou supprimer des opérations sur n'importe quelle information d'enregistrement CRM. Il vous permettra également de stocker des données de configuration spécifiques à l'extension et à l'utilisateur ou de vous connecter à des applications externes à l'aide des données stockées spécifiques à l'extension. Toutes ces données sont accessibles à l'aide d'une autorisation de base, c'est-à-dire par le nom d'utilisateur et la clé d'accès.

Création d'une API REST

Voici les cinq étapes générales que vous pouvez utiliser pour créer n'importe quelle API :

  1. Planifier l'API : les directives de conception de votre API sont fournies par des spécifications d'API telles que OpenAPI. Il est préférable de considérer différents cas d'utilisation au préalable et de s'assurer que l'API est conforme aux normes de développement d'API en vigueur.
  2. Construire l'API: les concepteurs d'API créent des prototypes de nouvelles API en modifiant peu les API existantes. Les développeurs peuvent adapter le prototype aux exigences internes après qu'il ait été testé.
  3. Testez l'API: Semblable aux tests de logiciels, les tests d'API sont nécessaires pour se prémunir contre les erreurs et les défauts. Testez la force de l'API contre les attaques en ligne à l'aide d'outils de test d'API.
  4. Documenter l'API: Bien que les API soient explicites, la documentation peut aider les utilisateurs plus facilement. Dans une architecture orientée services, des API bien documentées avec diverses fonctions et cas d'utilisation sont plus fréquemment utilisées. Rédigez un document d'aide pour donner des instructions et aider les autres à créer leurs API.
  5. Commercialiser l'API: Il existe des marchés en ligne où les développeurs peuvent acheter et vendre des API à d'autres, tout comme il en existe pour les produits de détail sur eBay, Amazon et Flipkart. Vous pouvez gagner de l'argent grâce à votre API en la listant.

Ce blog vous apprendra comment créer une commande d'API REST personnalisée à l'aide du concepteur d'API de Vtiger. Alors, commençons.

Qu'est-ce qu'un concepteur d'API ?

Le concepteur d'API est un outil ou des développeurs d'applications que les développeurs d'applications peuvent utiliser pour créer des API de service Web personnalisées. Vous pouvez définir vos points de terminaison de service personnalisés et vos paramètres de requête. Ces API peuvent être utilisées pour interagir avec les données CRM, s'intégrer à des applications externes et également exposer ces données aux API Javascript VTAP à utiliser dans des pages personnalisées ou des widgets dans l'interface utilisateur Vtiger.

Vous pouvez créer des API à l'aide de Vtiger Application Design Language (VADL), qui est vaguement basé sur la syntaxe XML. Le VADL permet aux administrateurs ou aux développeurs sans compétences de programmation de haut niveau de définir facilement des API, mais avec une compréhension de base de la programmation, vous créez rapidement des API efficaces.

Les API REST suivent le protocole API REST standard et vous pouvez définir leurs points de terminaison comme suit :

https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

Pour l'API REST, les méthodes de requête HTTP suivantes sont prises en charge :

  • ÉCONOMISEZ
  • POSTEZ
  • PUT
  • EFFACER

Voyons comment vous pouvez utiliser VTAP pour créer votre API REST personnalisée.

Les utilisateurs de Vtiger CRM peuvent créer des API REST qui connecteront le CRM à d'autres applications tierces ou en créer de nouvelles qui étendront les fonctionnalités du CRM. Voici un exemple:

Créons une API REST qui peut accéder aux données de une spécificité module en utilisant le VTAP.

Voici un exemple de API qui récupère les données du module CRM appelé Organisations pour afficher les cinq premières organisations avec les revenus annuels les plus élevés avec un nom d'API comme top_organisations. Vous pouvez choisir un nom différent pour le garder unique.

Avant de commencer, comprenons les composants XML et VDAL qui vont être utilisés pour définir les actions de l'exemple d'API ci-dessus.

Le tableau suivant décrit les composants XML et VDAL qui seront utilisés pour définir l'API REST personnalisée pour accéder et afficher les données CRM :

Composant XML et VDAL Action
méthode api = "obtenir" Définition de la méthode de requête HTTP
select module="Comptes" Définissez le module pour récupérer les données à partir de Sélectionner
record
nom du champ = "nom du compte">
Définissez les champs de l'enregistrement pour récupérer les données à l'aide de record
sort
nom du champ = "revenu_annuel" commande = "décroissant" / champ
/trier
Définissez les conditions pour le résultat du tableau en utilisant sort
limite max=”5″ page=”@page” /limit Définissez le nombre de détails d'enregistrement à afficher à l'aide de limite
/sélectionner
/API
Terminer en fermant toutes les balises ouvertes

Notes que tous les composants XML et VDAL du tableau ci-dessus doivent être entourés de balises (<>).

Suivez ces étapes pour créer l'API REST décrite ci-dessus :

  1. Connectez-vous à votre compte Vtiger CRM.
  2. Cliquez Menu principal.
  3. Cliquez Plateforme.
  4. Sélectionnez Concepteur d'API.
  5. Cliquez + Ajouter une API.
  6. image1

  7. Cliquez Création à côté de l'API REST. La fenêtre Ajouter une API REST s'ouvre.
  8. image4

  9. Ajouter une API REST: saisissez ou sélectionnez des informations pour les éléments suivants :
    1. Module: Sélectionnez le module CRM à partir duquel les données doivent être accédées.
    2. Prénom: Entrez un identifiant unique pour l'API.
    3. Statut: Cliquez sur la case à cocher pour activer l'API.
  10. Cliquez Épargnez.
  11. image2

  12. Après avoir ajouté l'API, vous verrez un IDE intégré dans lequel vous utiliserez VADL pour définir des API et des nœuds XML pour récupérer les données CRM. Reportez-vous au tableau ci-dessus pour comprendre les composants XML et VADL.
  13. image3

  14. Cliquez Enregistrer et publier pour publier l'API construite.

Vous pouvez accéder et tester l'API REST ci-dessus à partir de n'importe quelle application externe à l'aide de l'URL suivante.

https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

Notes que l'URL ci-dessus est un exemple, et vous devrez définir le point de terminaison selon votre instance CRM.

LE SAVIEZ-VOUS?
Les données ci-dessus peuvent être utilisées pour s'afficher sous forme de liste sur une page personnalisée ou utilisées pour un graphique à barres et d'autres résultats dynamiques à l'aide de composants javascript pour définir vos API. Toutes les API REST personnalisées intégrées dans API Designer sont également accessibles à l'aide de API Javascript VTAP.

Pour en savoir plus sur la création d'API personnalisées et de VTAP, consultez Documentation VTAP.