Solution native d’API Management (gestion des API) de Google Cloud, APIgee permet de créer, gérer, sécuriser, surveiller et d’exploiter des API, quels que soient les cas d’usage, l’environnement ou l’envergure du projet. 

En fournissant une couche d'abstraction entre les API internes et externes, cette solution libère véritablement le potentiel des développeurs et des équipes chargées des API.

Puissante, la plateforme APIgee s’appuie sur une terminologie bien spécifique, différente de celle utilisée par les autres plateformes de gestion d’API du marché. Typiquement, le terme « reverse-proxy API » couramment utilisé en dehors de l’écosystème Google Cloud ne s’applique pas à l’univers APIgee. Mais ne laissez pas les termes spécifiques d'APIgee vous effrayer ! 

Vous trouverez ci-dessous un tableau qui décrit à quelle fréquence ces termes spécifiques sont utilisés dans les forums par les développeurs, les utilisateurs et les partenaires d'APIgee.

Afin de vous aider à vous familiariser avec APIgee, nous vous proposons ci-après une liste de termes spécifiques à cet univers. Elle inclut le vocabulaire lié aux API mais aussi au réseau et à la mise en production, ainsi que des liens pour approfondir le sujet si vous le souhaitez.

API Analytics : collecte et calcule une multitude d'informations qui transitent par des API Proxys (proxys des API). Les données peuvent être utilisées par différentes équipes. Elles sont souvent exploitées pour des analyses dans les scénarios n’exigeant pas de temps réel.
> API Analytics

API Consumer : désigne un développeur d'applications (App Developers) qui exploite les API créées par un fournisseur d'API.
> Qu’est un API Consumer ?

API Developer (Développeur d'API) : un ingénieur logiciel faisant partie d’une organisation qui conçoit des APIs (un fournisseur d’API ou API Provider). Les APIs créées par les API Developers sont ensuite utilisées par les développeurs d'applications (API Consumers) pour créer des applications.
> API Developer

API Package (ensemble d’APIs) : ensemble de produits APIs (API Products) présentées aux développeurs sous forme de bundle (package) auquel est généralement associé un plan tarifaire.
> API versus Packages

API Product (produit API) : une collection de ressources API (d’URIs) associée à un plan de service et présentée sous forme de « bundles » aux développeurs. Un API Product peut aussi intégrer des métadonnées spécifiques à votre entreprise ou secteur d’activité pour la supervision ou l’analyse. Une ou plusieurs ressources peuvent être monétisées en les intégrant dans un API Product, ce dernier pouvant être distribué sous la forme d’un API Package pour sa monétisation.
> APIgee: API Product

API Provider (fournisseur d’API) : un API Provider construit des API en utilisant APIgee, API qui sont utilisées par les API Consumers (les développeurs d’applications).
> Definition d’API Provider

App Developer : synonyme d’API Consumer. Un développeur d’applications (App Developer) enregistre ses applications auprès d’un API Provider afin d’obtenir ses clés d’accès aux API (API keys) indispensables pour appeler les API Proxys du fournisseur et s’authentifier.
> Register App Developers

APIgee APIs : APIgee est une plateforme. Elle peut dès lors être pilotée par programmation au travers différentes opérations RESTful exposées sous forme d’API qui lui sont propres. Ces dernières permettent de configurer les environnements, les organisations, les proxys, la gestion des API, etc.
> Documentation APIgee

APIgee Analytics : Outils internes d’analyses d’APIgee. Ils collectent et calculent une multitude d'informations qui transitent par les API Proxys. Vous pouvez visualiser ces données à l'aide de graphiques et de diagrammes dans l'interface utilisateur d'APIgee, ou télécharger les données brutes pour une analyse hors ligne à l'aide des API d'APIgee.
> What is APIgee Analytics?

API Proxy : Un Proxy qui agit comme une façade pour votre API existante. Plutôt que d’appeler directement l’API, les développeurs appellent l’API générée par APIgee. Cette façade dissocie l’API elle-même (API Backend) de son interface publique. Ce principe protège les développeurs des modifications apportées à l’API Backend tout en vous permettant d’innover à volonté sans affecter les équipes de développement internes.
Pendant que vous procédez aux modifications Backend, les développeurs continuent d’appeler la même API sans interruption grâce à l’API Proxy. Dans des scénarios plus avancés, APIgee vous permet d’exposer plusieurs interfaces à une même API ce qui vous permet de personnaliser la signature d’une API pour répondre simultanément aux besoins de plusieurs niches de développeurs.
> What is an API Proxy?

Environment (Environnement APIgee) : Désigne un contexte d'exécution pour les API. Une API doit être déployée dans un environnement avant de pouvoir y accéder au moment de l'exécution. Par défaut APIgee provisionne deux environnements : test et prod.
> Environment API

Environment Groups : Un groupe d'environnement (Environment Group) est le mécanisme de base pour définir la façon dont les demandes sont acheminées vers les environnements individuels. Vous définissez les noms d'hôtes sur vos groupes d'environnements (et non sur les environnements individuels), et APIgee achemine les demandes vers les environnements d'un groupe en utilisant ces définitions de noms d'hôtes.
> Environment Groups

Organisation : Un conteneur pour toutes les entités d'un compte APIgee, y compris les API Proxys, API Products, API Packages, applications et développeurs. Pour installer et utiliser APIgee ou APIgee hybrid, vous devez disposer d'une organisation APIgee liée à un projet Google Cloud. Cette condition est remplie lorsque vous créez l'organisation dans le cadre d'un processus appelé "provisionnement".
Il est important de retenir qu’une organisation APIgee n'est pas la même chose qu'une organisation Google Cloud.
> Understanding Organizations

Pay-as-you-go (paiement à l'utilisation) : Lorsque vous utilisez la tarification à l'utilisation pour APIgee, vous êtes facturé pour ce qui suit :

• Le nombre de nœuds de passerelle (gateway) APIgee dans l'organisation APIgee - Un nœud de passerelle APIgee (APIgee gateway node) est une unité d'un environnement APIgee qui traite le trafic API. Plus le nombre de nœuds est élevé, plus vous traitez de trafic API pour cet environnement. APIgee suit le nombre de nœuds de passerelle utilisés par votre organisation APIgee au fil du temps. Avec la tarification "Pay-as-you-go", vous êtes facturé pour le nombre de nœuds utilisés, mesuré chaque minute. Tous les nœuds que vous approvisionnez sont facturés pour un minimum d'une minute.
  

• Le nombre de requêtes API traitées par les services APIgee Analytics - Les requêtes API, qu'elles aboutissent ou non, sont traitées par la plateforme APIgee Analytics. Vous êtes facturé pour le nombre total de demandes API analysées par mois. Les données analytiques sont conservées pendant une période de trois mois.
  

• L'utilisation du réseau - Une instance APIgee n'est disponible que sur le réseau avec lequel elle est associée. Vous pouvez exposer l'instance en externe en créant un load balancer Google Cloud. Vous payez tous les frais de réseau associés tels que l'adresse IP, le trafic sortant (network egress) et les règles de transfert (forwarding rules) en fonction de l'utilisation réelle.
  NB : Les frais associés au trafic sortant des instances APIgee (jusqu'à 1 To/mois) sont offerts jusqu'au 18 février 2023 dans le cadre d'une offre promotionnelle.

Pour en savoir plus : What is Pay-as-you-go ?

Policy (Stratégie) : Une « Policy » représente une étape de traitement qui s'exécute comme une unité logique atomique et réutilisable dans un flux d'API. Voici quelques exemples de « Policy » typiques : l'acheminement des demandes vers le point de terminaison approprié, la transformation du format d'un message, l'application du contrôle d'accès, l'appel de services distants pour obtenir des informations supplémentaires, le masquage des données sensibles aux utilisateurs externes, l'examen du contenu des messages pour détecter des menaces potentielles, la mise en cache des réponses communes pour améliorer les performances, etc.
Ces stratégies peuvent être exécutées de manière conditionnelle en fonction du contenu ou du contexte d'une demande ou d'un message de réponse. Par exemple, une « policy » de transformation peut être exécutée pour personnaliser un format de réponse particulier si le message de demande a été envoyé depuis un smartphone.

Resource, Resource path : C’est un concept RESTful. Un « resource path » est une URI (uniform resource identifier) qui identifie le chemin d’accès à une ressource donnée.
> Resources

Revision : Chaque API Package dispose d’un numéro de version et d’un numéro de révision. Un numéro de révision indique un changement dans le code de l’API qui ne casse pas la compatibilité. C’est un numéro interne sans impact pour les développeurs qui appellent l’API. Il représente l’évolution du package (configurations et stratégies) embarqué dans l’API Proxy.
> Diff between Revisioning and Versioning

Version : Contrairement au numéro de révision, le numéro de version marque les évolutions majeures des API engendrant des incompatibilités. Ce numéro est exposé aux développeurs comme dans les exemples suivants : pivotaltracker.com/services/v3 ou api.enterprise.APIgee.com/v1.
Dit autrement, les interfaces d’API ont des numéros de version, les API Proxys ont des numéros de révision.
> Diff between Revisioning and Versioning

Prochaines étapes 

Maintenant que vous maîtrisez la terminologie d'APIgee, vous êtes prêt à explorer les arcanes d’APIgee et à plonger dans cet univers d’une grande richesse.
Pour approfondir vos connaissances, nous vous recommandons vivement d'explorer la documentation d’APIgee X mais aussi de lire notre article « utiliser reCAPTCHA Enterprise dans les API ».
Nous vous invitons également à rejoindre la communauté APIgee pour apprendre de vos pairs et en savoir plus sur le monde des API et ses évolutions.