Aller au contenu
Cabinet d'expertise en transformation technologique · ARDIANE Group Innover, sécuriser, réussir

Lexique

API management : définition, composants d'une plateforme et notions voisines

Domaine

Ingénierie

L'essentiel

L'API management, ou gestion des API, désigne à la fois la discipline qui encadre la publication, la sécurité, le suivi et le retrait des interfaces de programmation d'une organisation, et la famille d'outils qui la sert. Une décomposition en usage y distingue une passerelle, qui reçoit les appels, des fonctions d'administration, un portail destiné aux développeurs et un suivi de l'usage.

Sommaire de la page

Définition de l’API management

Une API (interface de programmation d’application) est le contrat par lequel un logiciel met ses fonctions ou ses données à la disposition d’autres logiciels. L’API management, ou gestion des API, désigne dans l’usage deux choses liées : une discipline, qui encadre la vie des API d’une organisation de leur conception à leur retrait, et une famille d’outils, qui assure leur exposition, leur protection et leur suivi.

Les documentations publiques de trois fournisseurs de cloud en donnent des exemples. Microsoft présente Azure API Management comme une plateforme de gestion des API couvrant leur cycle de vie, Google décrit Apigee comme sa plateforme d’API management, et AWS décrit Amazon API Gateway comme un service pour créer, publier, maintenir, surveiller et sécuriser des API. S’y ajoutent les logiciels d’éditeurs spécialisés.

Ce que règle l’API management lorsque les API se multiplient

Lorsque les API d’une organisation se multiplient, des questions restent ouvertes si personne ne les porte : quelles API existent, qui les consomme, avec quels droits, dans quelle version. La discipline y répond par quatre moyens :

  • un inventaire des API, avec un propriétaire pour chacune ;
  • des règles de sécurité appliquées en un point, au lieu d’être réécrites dans chaque application ;
  • une documentation publiée, qui permet à un consommateur de se raccorder sans solliciter l’équipe productrice ;
  • une politique de versions et de retrait, annoncée aux consommateurs.

Elle sert aussi à ouvrir un système ancien sans le modifier, stratégie d’encapsulation que décrit notre page sur la modernisation applicative.

Les composants d’une plateforme de gestion des API

La documentation d’Azure API Management distingue une passerelle, un plan d’administration et un portail développeur ; celle d’Apigee décrit une couche de proxys placée devant les services et un portail pour les développeurs. Sous des noms qui varient d’un produit à l’autre, une décomposition en usage retient quatre fonctions.

Composant Rôle
Passerelle d’API (API gateway) Reçoit les appels, vérifie les identifiants, applique les quotas, achemine vers le service concerné
Administration Sert à déclarer les API, leurs règles d’accès et leurs versions
Portail développeur Présente le catalogue et la documentation, reçoit les demandes d’accès
Suivi Journalise les appels, mesure l’usage, alerte en cas d’anomalie

Deux spécifications publiques reviennent dans ce domaine : OpenAPI, publiée par l’OpenAPI Initiative, pour écrire le contrat d’une API HTTP, et le cadre d’autorisation OAuth 2.0 de l’IETF (RFC 6749), par lequel une application tierce obtient un accès limité à un service HTTP.

API management, passerelle d’API, urbanisation, schéma directeur : ne pas confondre

La passerelle est le composant d’exécution de l’API management. Installée sans inventaire, sans propriétaires et sans politique de versions, elle achemine des appels sans les gouverner.

L’urbanisation du SI fixe le découpage du système d’information et les règles d’échange entre ses parties. L’API management intervient en aval : il applique ces règles aux interfaces effectivement exposées.

L’architecture d’entreprise décrit l’organisation entière, du métier aux infrastructures. Les API y sont un mode d’échange parmi d’autres, aux côtés des événements et des fichiers.

Le schéma directeur SI est un document de planification. Il peut inscrire le déploiement d’une plateforme d’API parmi ses chantiers et lui attribuer un budget, sans en décrire le fonctionnement.

Un cas d’école : des horaires de bus ouverts aux applications tierces

Prenons un réseau de transport public qui veut laisser des applications tierces afficher les prochains passages de ses bus. L’équipe décrit l’API dans un document OpenAPI et la publie sur le portail développeur. Un éditeur d’application s’y inscrit et reçoit des identifiants. À chaque appel, la passerelle vérifie ces identifiants, applique le quota convenu et transmet la demande au système d’information voyageurs.

Plus tard, le format de réponse doit changer. Une version 2 est publiée, et le retrait de la version 1 est annoncé avec une date. Le suivi des appels indique quels consommateurs utilisent encore l’ancienne version, pour les prévenir avant la coupure.

Le choix du mode d’échange et les règles de conception des interfaces sont traités dans notre page consacrée à l’architecture SI.

FAQ

Questions fréquentes

Une autre question ? Posez-la-nous

Qu'est-ce que l'API management ?

L'API management, ou gestion des API, désigne la discipline qui encadre la publication, la sécurité, le suivi et le retrait des interfaces de programmation d'une organisation. Le terme désigne aussi la famille d'outils qui sert cette discipline. Une décomposition en usage distingue dans ces outils une passerelle, des fonctions d'administration, un portail destiné aux développeurs et un suivi de l'usage.

Quelle différence entre API management et API gateway ?

L'API gateway, ou passerelle d'API, est le composant qui reçoit les appels, contrôle les accès et achemine les demandes vers les services. L'API management couvre un périmètre plus large : l'inventaire des API, leur documentation, leurs versions, leur retrait et la mesure de leur usage. La passerelle est donc l'un des composants d'une plateforme d'API management.

À quoi sert un portail développeur ?

Un portail développeur est le site où une organisation présente le catalogue de ses API, leur documentation et leurs conditions d'accès. Un développeur y découvre les interfaces disponibles, demande des identifiants et apprend à s'y raccorder. Le portail vise à éviter que l'équipe qui produit une API renseigne chaque consommateur un par un.

Qu'est-ce que la spécification OpenAPI ?

La spécification OpenAPI, publiée par l'OpenAPI Initiative sur le site openapis.org, est un standard ouvert de description des API HTTP, indépendant du langage de programmation. Elle sert à écrire le contrat d'une API dans un document YAML ou JSON. Ce document peut ensuite alimenter la documentation, la génération de code et les tests.

Un projet à faire aboutir ?

Un premier échange suffit pour situer votre enjeu, identifier les bons interlocuteurs et vous dire franchement ce que nous pouvons apporter.