Présentation de Gestion des APIWhat is API Management?

Gestion des API (API Management, APIM) aide les organisations à publier des API pour des développeurs externes, partenaires et internes, afin de libérer le potentiel de leurs données et services.API Management (APIM) helps organizations publish APIs to external, partner, and internal developers to unlock the potential of their data and services. Toutes les entreprises cherchent à étendre leurs opérations en tant que plateforme numérique, en créant de nouveaux canaux, en trouvant de nouveaux clients et en suscitant un engagement supérieur auprès de ceux existants.Businesses everywhere are looking to extend their operations as a digital platform, creating new channels, finding new customers and driving deeper engagement with existing ones. Il offre les compétences 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.API Management provides the core competencies to ensure a successful API program through developer engagement, business insights, analytics, security, and protection. Vous pouvez utiliser la gestion des API Azure pour prendre n’importe quel serveur principal et lancer un programme d’API à part entière qui repose sur ce dernier.You can use Azure API Management to take any backend and launch a full-fledged API program based on it.

Cet article fournit une vue d’ensemble des scénarios courants qui impliquent APIM.This article provides an overview of common scenarios that involve APIM. Elle donne également une vue d’ensemble des principaux composants du système APIM.It also gives a brief overview of the APIM system's main components. L’article fournit ensuite une présentation plus détaillée de chaque composant.The article, then, gives a more detailed overview of each component.

Vue d'ensembleOverview

Pour utiliser Gestion des API, les administrateurs créent des API.To use API Management, administrators create APIs. Chaque API se compose d'une ou plusieurs opérations et chacune peut être ajoutée à un produit ou plusieurs.Each API consists of one or more operations, and each API can be added to one or more products. 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.To use an API, developers subscribe to a product that contains that API, and then they can call the API's operation, subject to any usage policies that may be in effect. Scénarios courants :Common scenarios include:

  • Sécurisation d’infrastructures mobiles par régulation de l’accès à l’aide de clés d’API pour éviter les attaques par déni de service (DOS) en utilisant la limitation ou des stratégies de sécurité avancées, telles que la validation de jeton JWT.Securing mobile infrastructure by gating access with API keys, preventing DOS attacks by using throttling, or using advanced security policies like JWT token validation.
  • Activation d’écosystèmes de partenaires ISV en proposant une intégration rapide des partenaires via le portail des développeurs et la création d’une façade d’API afin de se dissocier des implémentations internes qui ne sont pas appropriées à la consommation des partenaires.Enabling ISV partner ecosystems by offering fast partner onboarding through the developer portal and building an API facade to decouple from internal implementations that are not ripe for partner consumption.
  • Exécution d’un programme d’API interne en offrant un emplacement centralisé à l’organisation pour communiquer sur la disponibilité et les dernières modifications apportées aux API, tout en régulant l’accès basé sur des comptes professionnels, tous basés sur un canal sécurisé entre la passerelle de l’API et le serveur principal.Running an internal API program by offering a centralized location for the organization to communicate about the availability and latest changes to APIs, gating access based on organizational accounts, all based on a secured channel between the API gateway and the backend.

Le système est constitué des composants suivants :The system is made up of the following components:

  • La passerelle d’API est le point de terminaison qui :The API gateway is the endpoint that:

    • accepte les appels d’API et les dirige vers vos serveurs principaux ;Accepts API calls and routes them to your backends.
    • vérifie les clés d’API, les jetons JWT, les certificats et les autres informations d’identification ;Verifies API keys, JWT tokens, certificates, and other credentials.
    • applique des quotas d’utilisation et des limites de débit ;Enforces usage quotas and rate limits.
    • transforme votre API à la volée sans modification de code ;Transforms your API on the fly without code modifications.
    • met en cache les réponses du serveur principal lorsqu’il est configuré ;Caches backend responses where set up.
    • enregistre les métadonnées relatives aux appels à des fins d’analyse.Logs call metadata for analytics purposes.
  • Le portail Azure est l’interface d’administration où vous configurez votre programme d’API.The Azure portal is the administrative interface where you set up your API program. Utilisez-le pour :Use it to:

    • définir ou importer le schéma d’API ;Define or import API schema.
    • intégrer des API aux produits sous forme de packages ;Package APIs into products.
    • définir des stratégies, telles que des quotas ou des transformations sur les API ;Set up policies like quotas or transformations on the APIs.
    • obtenir des informations issues de l’analyse ;Get insights from analytics.
    • gérer les utilisateurs.Manage users.
  • Le portail des développeurs est le principal lieu sur le web où les développeurs peuvent :The Developer portal serves as the main web presence for developers, where they can:

    • lire la documentation de l’API ;Read API documentation.
    • essayer une API via la console interactive ;Try out an API via the interactive console.
    • créer un compte et s’abonner pour obtenir les clés d’une API ;Create an account and subscribe to get API keys.
    • accéder aux analyses relatives à leur propre utilisation.Access analytics on their own usage.

Pour plus d'informations, consultez le livre blanc Gestion des API basées sur le cloud : maîtrise de la puissance des API, disponible en version PDF.For more information, see the Cloud-based API Management: Harnessing the Power of APIs PDF whitepaper. Ce livre blanc d’introduction à la gestion des API, publié par CITO Research, présente les opérations suivantes :This introductory whitepaper on API Management by CITO Research covers:

  • Configuration requise des API et défis communsCommon API requirements and challenges
  • Découplage des API et présentation des façadesDecoupling APIs and presenting facades
  • Motivation des développeurs et exécution rapideGetting developers up and running quickly
  • Sécurisation de l'accèsSecuring access
  • Analyse et mesuresAnalytics and metrics
  • Prise de contrôle et aperçu d’une plate-forme de gestion des APIGaining control and insight with an API Management platform
  • Utilisation du cloud par rapport aux solutions localesUsing cloud vs on-premises solutions
  • Gestion des API AzureAzure API Management

API et opérations APIs and operations

Les API sont la base d'une instance du service Gestion des API.APIs are the foundation of an API Management service instance. Chaque API représente un ensemble d'opérations disponibles pour les développeurs.Each API represents a set of operations available to developers. Chaque API contient une référence au service principal qui implémente l'API, et ses opérations effectuent un mappage vers les opérations implémentées par le service principal.Each API contains a reference to the back-end service that implements the API, and its operations map to the operations implemented by the back-end service. Les opérations dans Gestion des API sont hautement configurables. Elles contrôlent le mappage d'URL, les paramètres de requête et de chemin d'accès, le contenu de la demande et de la réponse, et la mise en cache de la réponse de l'opération.Operations in API Management are highly configurable, with control over URL mapping, query and path parameters, request and response content, and operation response caching. La limite de débit, les quotas et les stratégies de restriction de l'adresse IP peuvent également être implémentés au niveau de l'API ou du fonctionnement individuel.Rate limit, quotas, and IP restriction policies can also be implemented at the API or individual operation level.

Pour plus d’informations, consultez les pages Création d’API et Ajout d’opérations à une API.For more information, see How to create APIs and How to add operations to an API.

Produits Products

Les produits sont la façon dont les API sont présentées en surface aux développeurs.Products are how APIs are surfaced to developers. 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.Products in API Management have one or more APIs, and are configured with a title, description, and terms of use. Les produits peuvent être ouverts ou protégés.Products can be Open or Protected. 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.Protected products must be subscribed to before they can be used, while open products can be used without a subscription. Lorsqu'un produit est prêt à l'emploi pour les développeurs, il peut être publié.When a product is ready for use by developers, it can be published. Une fois le produit publié, les développeurs peuvent l’afficher et s’y abonner (dans le cas des produits protégés).Once it is published, it can be viewed (and in the case of protected products subscribed to) by developers. L'approbation d'abonnement est configurée au niveau du produit et peut nécessiter l'approbation de l'administrateur ou être automatiquement approuvée.Subscription approval is configured at the product level and can either require administrator approval, or be auto-approved.

Les groupes permettent de gérer la visibilité des produits pour les développeurs.Groups are used to manage the visibility of products to developers. Les produits accordent de la visibilité aux groupes. Les développeurs peuvent afficher les produits visibles pour les groupes auxquels ils appartiennent et s'y abonner.Products grant visibility to groups, and developers can view and subscribe to the products that are visible to the groups in which they belong.

Groupes Groups

Les groupes permettent de gérer la visibilité des produits pour les développeurs.Groups are used to manage the visibility of products to developers. Le service Gestion des API possède les groupes système suivants, qui ne sont pas modifiables :API Management has the following immutable system groups:

  • Administrateurs : les administrateurs d’abonnements Azure sont membres de ce groupe.Administrators - Azure subscription administrators are members of this group. Les administrateurs gèrent les instances du service Gestion des API, créant les API, opérations et produits qui sont utilisés par les développeurs.Administrators manage API Management service instances, creating the APIs, operations, and products that are used by developers.
  • Développeurs : les utilisateurs authentifiés du portail des développeurs appartiennent à ce groupe.Developers - Authenticated developer portal users fall into this group. Les développeurs sont les clients qui génèrent des applications grâce à vos API.Developers are the customers that build applications using your APIs. 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.Developers are granted access to the developer portal and build applications that call the operations of an API.
  • Invités : les utilisateurs non authentifiés du portail des développeurs, comme les prospects, qui consultent le portail des développeurs d’une instance d’API Management appartiennent à ce groupe.Guests - Unauthenticated developer portal users, such as prospective customers visiting the developer portal of an API Management instance fall into this group. Ils peuvent recevoir certains accès en lecture seule, comme la possibilité d'afficher les API, mais pas de les appeler.They can be granted certain read-only access, such as the ability to view APIs but not call them.

Outre ces groupes système, les administrateurs peuvent créer des groupes personnalisés ou utiliser des groupes externes dans des locataires Azure Active Directory qui leur sont associés.In addition to these system groups, administrators can create custom groups or leverage external groups in associated Azure Active Directory tenants. Des groupes externes et personnalisés peuvent être utilisés avec des groupes système offrant une certaine visibilité aux développeurs et un accès aux produits d’API.Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. Vous pourriez, par exemple, créer un groupe personnalisé pour les développeurs affiliés à une organisation partenaire spécifique et leur permettre d’accéder aux API à partir d’un produit contenant uniquement des API pertinentes.For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. Un utilisateur peut être membre de plusieurs groupes.A user can be a member of more than one group.

Pour plus d’informations, consultez la page Création et utilisation de groupes.For more information, see How to create and use groups.

Développeurs Developers

Les développeurs représentent les comptes d'utilisateur dans une instance du service Gestion des API.Developers represent the user accounts in an API Management service instance. Ils peuvent être créés ou invités à rejoindre le groupe par les administrateurs, ou ils peuvent s’inscrire dans le Portail des développeurs.Developers can be created or invited to join by administrators, or they can sign up from the Developer portal. Chaque développeur est membre d'un ou plusieurs groupes, et peut s'abonner aux produits qui accordent de la visibilité à ces groupes.Each developer is a member of one or more groups, and can subscribe to the products that grant visibility to those groups.

Lorsque des développeurs s’abonnent à un produit, ils reçoivent les clés principale et secondaire pour le produit.When developers subscribe to a product, they are granted the primary and secondary key for the product. Cette clé est utilisée pour les appels dans les API du produit.This key is used when making calls into the product's APIs.

Pour plus d’informations, consultez les pages Création ou invitation de développeurs et Association de groupes aux développeurs.For more information, see How to create or invite developers and How to associate groups with developers.

Stratégies Policies

Les stratégies sont une fonctionnalité puissante de Gestion des API. Elles permettent au portail Azure de modifier le comportement de l’API grâce à la configuration.Policies are a powerful capability of API Management that allow the Azure portal to change the behavior of the API through configuration. 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.Policies are a collection of statements that are executed sequentially on the request or response of an 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.Popular statements include format conversion from XML to JSON and call rate limiting to restrict the number of incoming calls from a developer, and many other policies are available.

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.Policy expressions can be used as attribute values or text values in any of the API Management policies, unless the policy specifies otherwise. Certaines stratégies, telles que les stratégies Control flow et Set variable, sont basées sur des expressions de stratégie.Some policies such as the Control flow and Set variable policies are based on policy expressions. Pour plus d’informations, consultez les rubriques Stratégies avancées et Expressions de stratégie.For more information, see Advanced policies and Policy expressions.

Pour obtenir la liste complète des stratégies Gestion des API, consultez la page Référence de stratégie.For a complete list of API Management policies, see Policy reference. Pour plus d’informations sur l’utilisation et la configuration des stratégies, consultez la page Stratégies Gestion des API.For more information on using and configuring policies, see API Management policies. Pour consulter un didacticiel sur la création d’un produit avec des stratégies de limite de débit et de quota, référez-vous à la page Création et configuration de paramètres de produit avancés.For a tutorial on creating a product with rate limit and quota policies, see How create and configure advanced product settings.

Portail des développeurs Developer portal

Le portail des développeurs est l'endroit où les développeurs peuvent en savoir plus sur votre API, afficher et appeler des opérations et s'abonner à des produits.The developer portal is where developers can learn about your APIs, view and call operations, and subscribe to products. Les prospects peuvent consulter le portail des développeurs, afficher les API et opérations et se connecter.Prospective customers can visit the developer portal, view APIs and operations, and sign up. L’URL du portail des développeurs se trouve sur le tableau de bord du portail Azure pour votre instance de service Gestion des API.The URL for your developer portal is located on the dashboard in the Azure portal for your API Management service instance.

Vous pouvez personnaliser l'aspect de votre portail des développeurs en ajoutant du contenu personnalisé, en personnalisant des styles et en ajoutant votre marque.You can customize the look and feel of your developer portal by adding custom content, customizing styles, and adding your branding.

Gestion et économie des APIAPI Management and the API economy

Pour en savoir plus sur la gestion des API, regardez la présentation suivante issue de la conférence Microsoft Ignite 2017.To learn more about API Management, watch the following presentation from the Microsoft Ignite 2017 conference.

Étapes suivantesNext steps

Terminez le démarrage rapide suivant et commencez à utiliser la Gestion des API Azure :Complete the following quickstart and start using Azure API Management: