Gestion des API et excellence opérationnelle
Découvrez comment utiliser la Gestion des API afin de publier des API pour des développeurs externes, partenaires et employés de manière sécurisée et à grande échelle. Ce service réseau est une plateforme de gestion hybride et multicloud dédiée aux API dans tous les environnements.
Les composants sont les suivants :
Pour plus d’informations, consultez En savoir plus sur Gestion des API.
Pour comprendre comment Gestion des API prend en charge l’excellence opérationnelle, consultez les rubriques suivantes :
Check-list
Avez-vous configuré Gestion des API en tenant compte de l’excellence opérationnelle ?
- Sécurisez la communication entre Gestion des API et votre back-end.
- Assurez-vous que chaque partie dispose de ses propres informations d’identification lors de l’exposition d’API à des tiers.
- Veillez à définir des quotas et des limites de taux de transfert lors de l’exposition d’API à des tiers.
- Découvrez les instructions de conception et d’architecture de l’API REST de Microsoft.
- Activez le versioning des API pour maintenir la compatibilité descendante tout en ajoutant d’autres fonctionnalités.
- Utilisez les fonctionnalités de versioning et de révisions de Gestion des API pour implémenter le versioning des API.
- Comprenez les restrictions d’importation d’API dans Gestion des API.
- Comprenez la fonctionnalité de journalisation des événements.
- Suivez les appels dans Gestion des API Azure pour faciliter le débogage et le test.
- Configurez la journalisation avec Azure Monitor pour le service Gestion des API.
- Choisissez les modes appropriés pour accéder aux connexions de sites privés.
- Évaluez les règles de pare-feu et les listes d’adresses IP autorisées en fonction de l’adresse IP publique de Gestion des API.
Recommandations relatives à la configuration
Tenez compte des recommandations suivantes pour l’excellence opérationnelle lors de la configuration de votre service Gestion des API :
| Recommandation | Description |
|---|---|
| Veillez à définir des quotas et des limites de taux de transfert lors de l’exposition d’API à des tiers. | Protégez les services de back-end et réduisez la charge imposée à une unité d’échelle de Gestion des API. Les stratégies de limitation du débit peuvent être appliquées au niveau global, du produit, de l’API et des opérations pour fournir une personnalisation de la limite de débit appliquée aux consommateurs d’API. |
| Découvrez les instructions de conception et d’architecture de l’API REST de Microsoft. | Suivez les standards et les bonnes pratiques lors de l’utilisation de l’API REST. Les bonnes pratiques suivantes permettent une compatibilité maximale entre les plateformes et les implémentations. Passez en revue les instructions de l’API REST et l’aide sur la conception des API. |
| Comprenez les restrictions d’importation d’API dans Gestion des API. | Chaque effort est réalisé pour s’assurer que le processus d’importation d’API s’exécute sans problème, ce qui implique de ne pas exiger de personnalisations. Certains scénarios imposent des restrictions qui nécessitent une modification de la source d’importation. S’applique aux services REST et SOAP. Consultez Restrictions de stratégie pour connaître les restrictions d’importation d’API actuelles. |
| Comprenez la fonctionnalité de journalisation des événements. | Prend en charge la journalisation des événements dans un hub d’événements Azure pour effectuer une analyse en quasi-temps réel. Cette fonctionnalité s’intègre à la journalisation externe, aux solutions SIEM (Security information and Event Management) ou à l’analyse de l’utilisation des API en quasi-temps réel. |
| Suivez les appels dans Gestion des API Azure pour faciliter le débogage et le test. | Le suivi doit être activé sur l’abonnement utilisé pour effectuer la demande. Le suivi est activé demande par demande en utilisant la valeur d’en-tête Ocp-Apim-Trace. Le suivi d’API est également intégré au portail d’administration et est activé par défaut lors du test des API à partir du portail. |
| Configurez la journalisation avec Azure Monitor pour le service Gestion des API. | Les journaux peuvent être envoyés à un espace de travail Log Analytics pour permettre des requêtes et des analyses complexes. Les métriques peuvent être ingérées pour une analyse à long terme. Toutes les données sont ensuite exposées au moyen d’Azure Monitor. Il est possible d’intégrer Application Insights pour la gestion des performances des applications. |
| Choisissez les modes appropriés pour accéder aux connexions de sites privés. | Prend en charge l’intégration de Réseau virtuel en mode interne et externe. |
| Évaluez les règles de pare-feu et les listes d’adresses IP autorisées en fonction de l’adresse IP publique de Gestion des API. | Une adresse IP publique fixe est disponible pendant la durée de vie du service avec les plans De base, Développeur, Standard et Premium pour Gestion des API. |