Vue d’ensemble des Outils Web API et Services Tools Cegid Une API, c’est quoi ? Commençons par définir cet acronyme : API : Application Programming Interface Les APIs se définissent comme un ensemble de fonctions informatiques par lesquelles deux logiciels vont interagir sans intermédiation humaine. Une API se décompose donc en trois notions : Application : par application s’entend tout service avec lequel un développeur ou une autre application souhaite interagir. Interface : l’interface est la porte d’entrée par laquelle il sera possible d’interagir avec l’application. Programme : le programme est une fonction informatique à laquelle un développeur donne des instructions et qui va interagir avec l’application à notre place. Les APIs sont donc utilisées par des programmes informatiques, permettant leurs interactions sous des conditions déterminées et documentées.
Vue d’ensemble des Outils Web API et Services Tools Cegid Que fait une API ? Une API expose un service ou des données utiles pour un développeur. Nous l’avons vu, cela peut prendre des formes multiples: flux de données en temps réel, cartographie... En parallèle, les développeurs écrivent des programmes qui consomment ces APIs. Une API peut être utilisée dans différents environnements : Dans un environnement clos. Une API aide ainsi à briser les silos de données d’une entreprise en favorisant un accès mutualisé à l’information. Dans un environnement ouvert. Dans le cadre d’une démarche Open Data, l’API maximise la diffusion et les réutilisations des données Quelques APIs célèbres : API Google Maps. Par exemple, le service Airbnb utilise l’API Google Maps pour transformer les adresses des biens en points géolocalisés. API Facebook. Cette API permet aux internautes de s’identifier à des applications tierces avec leur compte Facebook. API Twitter. Cette API permet de développer des plates-formes de gestion multi-comptes comme TweetDeck.
Vue d’ensemble des Outils Web API et Services Tools Cegid Exposer des données (Web API personnalisée) Dans un premier temps, une API permet d’exposer des données. Il s’agit dès lors d’offrir aux développeurs ou aux utilisateurs un accès privilégié et fiable à ses données. Par exemple, Créer depuis Excel une liste des commandes ou écritures pour un reporting Utiliser une liste de données très réduite et spécialisée pour consulter une information rapidement à travers un site e-commerce Accéder à des données de manière libre et ouverte sur l’ensemble des données de la base, de manière sécurisée en s’appuyant sur les droits utilisateurs standards de l’ERP, avec une mise en œuvre simplifiée du fait de l’utilisation des standards Web (non lié à une application Cegid, pas de paramétrage lourd d’infrastructure ou de droits à prévoir, etc.). Retrouvez différents exemples d’utilisation de nos Web API personnalisées ici : Que faire avec une Web API personnalisée de données Plusieurs exemples de consommation de Web API de données
Vue d’ensemble des Outils Web API et Services Tools Cegid Exposer des services (Web API métier) Les APIs de service répondent à la nécessité d’interroger, filtrer ou trier les données tout en appliquant la logique métier de l’ERP Cegid. Par exemple, lorsque vous souhaitez dans votre site e-commerce afficher un niveau de stock article qui est géré dans Cegid, vous pouvez demander cette information au travers de la Web API de gestion de stock de votre ERP et récupérer cette information directement, en temps réel, dans votre site e-commerce. Cette API vous rend le service de calculer le niveau de stock pour votre site e-commerce en jouant la logique métier, c’est-à-dire en prenant en compte l’ensemble des éléments importants (commande en cours sur cet article, stock actuellement disponible, réapprovisionnement prévu, etc.). L’ERP Cegid Y2 expose plus de 120 Web API de services dans les domaines de la Finance, de la RH et de la Gestion. Pour consulter la liste de ces services vous pouvez y accéder directement ici sur notre site Cegid : Web API métier MT&S Web API métier RH Web API métier Finance
Vue d’ensemble des Outils Web API et Services Tools Cegid Protocole et documentation Une API est un point d’entrée fantastique pour un développeur ou un utilisateur expérimenté, à condition qu’il ne passe pas plus de temps à comprendre notre API qu’à bâtir un service innovant autour. En facilitant le travail des développeurs, on met en valeur son organisation et favorise les réutilisations. Il existe plusieurs manières de décrire le contrat d’une API. Pour l’API CEGID, nous utilisons Help Pages for ASP.NET Web API qui permet de présenter une nomenclature de description normalisée des paramètres à utiliser pour faire fonctionner la Web API, une documentation exhaustive et une console de test complète. En bref : CEGID utilise des frameworks descriptifs normalisés et répandus CEGID propose un point d’entrée unique et une arborescence rationnelle CEGID intègre une console de test intégrée CEGID livre des APIs normalisées Accédez directement à la documentation de nos Web API ici sur notre site Cegid : Web API métier MT&S Web API métier RH Web API métier Finance
Vue d’ensemble des Outils Web API et Services Tools Cegid Créer un écosystème innovant La possibilité d’un accès dédié à des données ou des services interopérables est un atout majeur dans le développement d’un écosystème innovant interne. Il en va de même lorsqu’une organisation décide d’ouvrir son système d’information par les APIs. Les APIs nourrissent des effets de réseaux numériques forts. Elles transforment les clients, les utilisateurs finaux, l’écosystème en collaborateurs. En plaçant les données et les services au cœur de cette démarche, on maximise leur transformation en services innovants.
Illustration d’une Web API Je cherche les informations sur le tiers ABATTOIRS DE BAZAS depuis mon application mobile L’application mobile consomme un service qui demande cette information à mon ERP hébergé dans mon entreprise Mon ERP me renvoie l’information Je la consomme dans mon application Internet Mon service est disponible via le Web
Vue d’ensemble des Outils Web API et Services Tools Cegid Web API Métiers Web API Personnalisées. Mise à disposition d’un outil nommé Data Service permettant de créer des Web API personnalisées Alert Service. Mise à disposition d’un outil permettant de créer des alertes sur la base de Web API personnalisées et de prévenir / informer via mail et portail les utilisateurs
Web API personnalisées
Web API Personnalisées de données – Cegid Data Service Je cherche les informations sur le tiers ABATTOIRS DE BAZAS L’application consomme un service qui demande cette information Le serveur applicatif me renvoie l’information Je la consomme dans mon application http://ws.cegid.pw/CegidDataService/odata/DEMOCDCAS/TIERS_FULL$filter=T_AUXILIAIRE%20eq%20%27177281%27 SELECT T_AUXILIAIRE, T_LIBELLE, T_ADRESSE1, T_CODEPOSTAL, T_VILLE FROM TIERS WHERE (T_AUXILIAIRE = '2717728'
Web API Personnalisées de données – Cegid Data Service Interrogation de la Querry Consommation de la Querry au travers de l’API et filtrage possible des données via le protocole OData Querry Cegid Exposition de la vue avec filtrage SQL et gestion des droits dans Cegid sous forme d’API Requête SQL Création d’une vue SQL dans le SGBD Cegid View Editor Cegid Data Services API personnalisée 12/11/2018
Services Tools Cegid Alert Service
Outil d’alerte Cegid Data ALert Cegid View Editor Cegid Data Service Cegid Alert
Dashboard Cegid Data Alert Résultat de l’alerte sous forme de vignettes dans un Dashboard 12/11/2018 Cegid
Email Cegid ALert Résultat de l’alerte sous forme de diffusion du résultat par email. Possibilité de traiter une action via Web API. 12/11/2018 Cegid
MERCI de votre attention