Découvrir le service Gestion des API
Gestion des API offre les fonctionnalités essentielles qui garantissent un programme d’API réussi au travers de l’engagement des développeurs, des perspectives commerciales, de l’analytique, de la sécurité et de la protection. Chaque API se compose d'une ou plusieurs opérations et chacune peut être ajoutée à un produit ou plusieurs. Pour utiliser une API, les développeurs s'abonnent à un produit qui contient cette API, puis ils peuvent appeler l'opération de l'API, sujette à toutes les stratégies d'utilisation pouvant être en vigueur.
Composants de Gestion des API
Gestion des API Azure se compose d’une passerelle d’API, d’un plan de gestion et d’un portail des développeurs. Ces composants sont hébergés sur Azure et complètement managés par défaut. Gestion des API est disponible dans différents niveaux qui diffèrent par leur capacité et leurs fonctionnalités.
La passerelle d’API est le point de terminaison qui :
- Accepte les appels d’API et les route vers les back-ends appropriés
- Vérifie les clés d’API et d’autres informations d’identification présentées avec les demandes
- applique des quotas d’utilisation et des limites de débit ;
- Transforme les demandes et les réponses spécifiées dans les déclarations de la stratégie
- Met en cache les réponses pour améliorer la latence des réponses et réduire la charge sur les services back-ends
- émet des journaux, des métriques et des rapports des appels de procédure pour la surveillance, des rapports et une résolution des problèmes.
Le plan de gestion est l’interface d’administration où vous configurez votre programme d’API. Utilisez-le pour :
- Approvisionner et configurer les paramètres du service Gestion des API
- Définir ou importer le schéma d’API
- Empaqueter des API sous forme de produits
- Configurer des stratégies telles que des quotas ou des transformations sur les API
- Obtenir des informations issues d’analyses
- Gérer les utilisateurs
Le Portail des développeurs est un site web généré automatiquement et entièrement personnalisable, avec la documentation de vos API. À l’aide du portail des développeurs, les développeurs peuvent :
- lire la documentation relative aux API ;
- appeler une API via la console interactive ;
- créer un compte et s’abonner pour obtenir des clés API ;
- accéder aux analyses relatives à leur propre utilisation ;
- télécharger des définitions d’API ;
- gérer les clés API.
Produits
Les produits sont la façon dont les API sont présentées en surface aux développeurs. Les produits dans Gestion des API possèdent une ou plusieurs API et sont configurés avec un titre, une description et des conditions d'utilisation. Les produits peuvent être ouverts ou protégés. Les produits protégés doivent faire l’objet d’un abonnement avant de pouvoir être utilisés, alors que les produits ouverts peuvent être utilisés sans abonnement. L’approbation de l’abonnement est configurée au niveau du produit, et peut nécessiter l’approbation de l’administrateur ou être approuvée automatiquement.
Groupes
Les groupes permettent de gérer la visibilité des produits pour les développeurs. Le service Gestion des API possède les groupes système suivants, qui ne sont pas modifiables :
- Administrateurs : Ils gèrent les instances du service Gestion des API et créent les API, les opérations et les produits qui sont utilisés par les développeurs. Les administrateurs d’abonnements Azure sont membres de ce groupe.
- Développeurs : Utilisateurs authentifiés du portail des développeurs qui créent des applications à l’aide de vos API. Les développeurs bénéficient d'un accès au portail des développeurs et génèrent des applications qui appellent les opérations d'une API.
- Invités : utilisateurs non authentifiés du portail des développeurs. Ils peuvent recevoir certains accès en lecture seule, comme la possibilité de voir les API, mais pas de les appeler.
Outre ces groupes système, les administrateurs peuvent créer des groupes personnalisés ou utiliser des groupes externes dans des locataires Microsoft Entra qui leur sont associés.
Développeurs
Les développeurs représentent les comptes d'utilisateur dans une instance du service Gestion des API. Ils peuvent être créés ou invités à rejoindre le groupe par les administrateurs, ou ils peuvent s'inscrire au Portail des développeurs. Chaque développeur est membre d'un ou plusieurs groupes, et peut s'abonner aux produits qui accordent de la visibilité à ces groupes.
Stratégies
Les stratégies sont un ensemble d'instructions qui sont exécutées dans l'ordre sur demande ou sur réponse d'une API. Les instructions les plus utilisées comprennent la conversion du format XML au format JSON et la limitation du débit d'appels pour restreindre le nombre d'appels entrants d'un développeur. De nombreuses autres stratégies sont disponibles.
Les expressions de stratégie peuvent être utilisées comme valeurs d’attribut ou valeurs de texte dans l’une des stratégies de Gestion des API, sauf si la stratégie le spécifie autrement. Certaines stratégies, telles que les stratégies Control flow et Set variable, sont basées sur des expressions de stratégie.
Les stratégies peuvent être appliquées à différentes étendues, en fonction de vos besoins : globale (toutes les API), un produit, une API spécifique ou une opération d’API.