API7 Enterprise v3.3.0 prend en charge l'API Portal

Aperçu du Portail Développeur

Le Portail Développeur est une plateforme dédiée conçue pour les consommateurs d'API (par exemple, les développeurs tiers et les équipes internes) qui fournit un accès unifié à la documentation des API, aux outils de test et aux ressources connexes. Ce portail facilite non seulement la compréhension et l'intégration rapides des API par les développeurs, mais améliore également les capacités de visualisation et de contrôle aux niveaux de la gestion et de la sécurité. Pour une plateforme de passerelle API, offrir un portail développeur permet les avantages suivants :

1. Exposition simplifiée des API : En consolidant la documentation fragmentée, les exemples et les spécifications d'interface sur une plateforme unifiée, le portail réduit considérablement les coûts d'intégration et accélère l'intégration des produits avec les systèmes externes.

2. Amélioration de l'efficacité de la R&D et des opérations : Les fonctionnalités en libre-service comme la recherche de documentation, les tests et le débogage réduisent la communication répétitive et la maintenance de la documentation, améliorant ainsi l'efficacité globale.

3. Gestion et surveillance centralisées : La plateforme permet un meilleur suivi de l'utilisation des API, l'analyse des réponses et la surveillance des indicateurs clés, ainsi que la détection précoce des problèmes potentiels.

Dans API7 Enterprise 3.3.0, API7 Gateway prend désormais en charge la génération automatique d'un portail développeur directement à partir de la documentation API fournie par l'utilisateur. Cette capacité permet aux organisations d'exposer plus facilement les ressources API aux parties externes tout en offrant une expérience cohérente et pratique aux développeurs.

Portail Fournisseur API7 et Portail Développeur

En tant que plateformes de gestion d'API, le Portail Fournisseur API7 et le Portail Développeur jouent des rôles complémentaires mais s'adressent à des publics et des fonctionnalités différents.

Portail Fournisseur API7

Le Portail Fournisseur API7 est une console de gestion conçue pour les fournisseurs d'API afin de faciliter la gestion du cycle de vie des API.

• Public cible : Fournisseurs et administrateurs d'API
• Fonctions principales :
  • Publication et gestion des produits API.
  • Gestion des développeurs.
  • Configuration des politiques d'accès au Portail Développeur, telles que la visualisation anonyme des API et les méthodes de connexion.
  • Visualisation des statistiques d'accès aux API, analyse des données et suivi des journaux.

Portail Développeur API7

Le Portail Développeur API7 fournit un point d'entrée unifié en libre-service pour les développeurs ou partenaires, leur permettant de comprendre, accéder et utiliser rapidement les services API.

• Public cible : Consommateurs d'API, tels que les développeurs tiers, les partenaires ou les équipes de développement internes
• Fonctions principales :
  • Fourniture de documentation API, de guides d'utilisation et de codes d'exemple.
  • Offre d'interfaces de test et de débogage en ligne.
  • Gestion de l'enregistrement des applications, obtention des clés API et gestion des informations d'authentification.

Comment utiliser le Portail API7

Accéder au Portail Fournisseur API7

Après s'être connecté au tableau de bord d'API7 Enterprise, les utilisateurs sont redirigés par défaut vers la page de gestion de la passerelle. Pour basculer vers le Portail Fournisseur API7, cliquez sur le bouton de bascule en haut à gauche. Après le basculement, le titre de la page est mis à jour en Portail Fournisseur API7, et le menu de gauche reflète les options pertinentes pour la gestion des produits API.

Créer et publier des produits API

Les produits API sont une ressource centrale dans le Portail Fournisseur API7, représentant un groupe d'API liées. Les développeurs s'abonnent généralement aux API au niveau du produit. Il existe deux méthodes pour créer des produits API.

1. Basé sur les services publiés dans API7 Gateway

• Sélectionnez les services publiés existants dans API7 Gateway et regroupez-les en un produit API.
• Dans le produit API, chaque route correspondant à un service est traitée comme une API indépendante.

2. Importation de fichiers OpenAPI

• Générez rapidement des produits API en important des fichiers OpenAPI existants.
• Notez que les produits créés de cette manière ne sont pas directement liés aux configurations de la passerelle.

Exemple : Ajouter un produit API à partir d'API7 Gateway

Pour ajouter un produit API, cliquez sur le bouton "Ajouter un produit API" et sélectionnez l'élément de menu "Depuis API7 Gateway" pour accéder au formulaire de création de produit API.

Dans le formulaire, vous devez remplir les informations suivantes :

1. Informations de base : Inclut le nom, la description, les étiquettes, le logo, etc.

2. Type d'authentification : Spécifiez si une approbation est requise.

3. Visibilité : Définissez la portée de visibilité du produit API.

4. Services de passerelle liés : Sélectionnez un service de passerelle publié qui répond aux deux conditions suivantes :

   • Un nom d'hôte a été configuré.
   • Un document OpenAPI a été téléchargé.

Ajouter un nouveau produit API

Si aucun service ne répond aux exigences, vous pouvez suivre les étapes de configuration ci-dessous.

1. Télécharger un document OpenAPI et configurer le nom d'hôte pour les services existants

Dans la page des détails du service ou du modèle de service, cliquez sur Spécification OpenAPI dans la barre de navigation de gauche. Ensuite, téléchargez le document OpenAPI correspondant pour le service. Assurez-vous que les définitions d'API dans le document correspondent précisément aux routes réelles du service. Cela garantit aux développeurs une documentation API précise pendant le débogage et un accès en amont réussi.

Après avoir téléchargé le document, vous pouvez le prévisualiser en temps réel, ce qui reflète la documentation API finale à laquelle les développeurs auront accès.

Ensuite, dans la section Routes de la page des détails du service ou des détails du modèle, configurez les hosts dans le module URL de demande. Par défaut, les hosts sont définis sur "*", ce qui signifie que le service traite les demandes de n'importe quel nom d'hôte.

Pour lier le service à un produit API, un hôte précis doit être spécifié. Cette exigence garantit que les développeurs peuvent accéder aux API en utilisant le format de chemin complet : hôte + préfixe de chemin + API.

2. Créer un nouveau service pour le lier à un produit API

Si aucun service n'a été publié, vous pouvez créer un nouveau service en téléchargeant un document OpenAPI comme modèle de service et en le publiant, ou en créant un service directement dans le groupe de passerelle. Les services créés de cette manière analysent automatiquement les API définies dans OpenAPI en routes, conservant le document sans nécessiter de re-téléchargement. Configurez le host comme décrit précédemment pour rendre le service éligible à la liaison avec un produit API.

Une fois la configuration de la passerelle terminée, retournez au portail fournisseur et cliquez sur Ajouter un service de passerelle lié. Sélectionnez le service publié requis pour compléter la liaison.

Par défaut, le nouveau produit API créé sera dans un état de brouillon, invisible pour les développeurs. Avant la publication, vérifiez la documentation API, les paramètres de visibilité et les paramètres d'authentification. Il est recommandé de configurer les notifications d'événements de produit API (par exemple, approbation ou annulation d'abonnement) pour éviter de manquer des mises à jour critiques.

Publier un produit API

Après avoir vérifié le produit API, cliquez sur le bouton Publier en haut à droite et confirmez. Les développeurs correspondant aux paramètres de visibilité peuvent alors accéder au produit via le Portail Développeur.

Accéder au Portail Développeur API7

Vous pouvez accéder au Portail Développeur API7 de deux manières :

1. Visitez l'URL du Portail Développeur.
2. Cliquez sur le bouton Portail Développeur dans le menu de gauche du tableau de bord du Portail API7.

Sur la page d'accueil du Portail Développeur API7, cliquez sur le bouton Connexion en haut à droite pour vous connecter.

Créer un développeur

Il existe deux façons de créer un compte développeur :

• Auto-inscription : Les développeurs s'inscrivent eux-mêmes sur la page de connexion.
• Invitation par l'administrateur : Les administrateurs créent des comptes via le tableau de bord du Portail API7.

Auto-inscription

Cliquez sur le bouton S'inscrire sur la page de connexion, et remplissez le formulaire avec un nom d'utilisateur et un mot de passe.

Inscription initiée par l'administrateur

Dans le tableau de bord du Portail API7, naviguez vers la section Développeurs et cliquez sur Inviter un développeur. Remplissez le formulaire avec le nom d'utilisateur et un mot de passe à usage unique, et fournissez éventuellement un nom d'affichage pour l'identification.

Après avoir ajouté le développeur, partagez le nom d'utilisateur et le mot de passe avec l'utilisateur. Lors de la première connexion, ils doivent réinitialiser leur mot de passe.

Voir les produits API

Après s'être connecté, les développeurs peuvent cliquer sur API Hub pour voir tous les produits API publiés.

En plus de voir la documentation API, le système prend également en charge la génération d'exemples de code multi-langues pour chaque API sur la page de détails. Les développeurs peuvent copier ces exemples de code dans leur environnement de développement pour les tester.

Déboguer les produits API

En outre, les développeurs peuvent tester les API directement en cliquant sur le bouton Tester la demande.

Après avoir cliqué sur Tester la demande, vous pouvez voir un panneau de test en ligne.

• L'URL de demande est générée automatiquement en fonction de la configuration du service associé au produit API.
• La Méthode d'authentification est par défaut Key Auth et remplit automatiquement la clé API pour le compte développeur actuel.

Les développeurs n'ont qu'à compléter les paramètres de demande requis selon la définition de l'interface API pour procéder au débogage.

S'abonner aux produits API

Si un produit API est restreint à des utilisateurs spécifiques, l'administrateur du portail fournisseur peut désactiver l'option Les développeurs non abonnés peuvent voir les détails de l'API dans les paramètres de visibilité du produit. Cela garantit que les développeurs doivent s'abonner au produit avant de pouvoir accéder ou invoquer ses API.

Lorsqu'un développeur accède à la page de détails du produit API sous ce paramètre, un bouton "S'abonner pour débloquer" sera affiché. Cliquer sur le bouton envoie une demande d'abonnement à l'administrateur du fournisseur.

Si le processus d'approbation est activé pour le produit API, le développeur doit attendre l'approbation de l'administrateur avant de pouvoir accéder aux détails.

Dans le menu Organisation du Portail Fournisseur API7, s'il y a des approbations en attente, un point rouge apparaîtra à côté de l'élément de menu Approbations comme indicateur. Cliquer sur cet élément de menu navigue vers la page de gestion des approbations.

La page d'approbation est conçue pour gérer les demandes des développeurs d'accéder aux ressources API. Les administrateurs peuvent examiner les informations de demande suivantes sur cette page : type d'événement, nom de la ressource, demandeur et heure de la demande. À travers l'interface, les administrateurs peuvent agir pour Approuver ou Rejeter la demande.

La décision d'approbation a un impact direct sur les permissions d'accès aux API du développeur :

• Approuver : Le développeur obtient l'accès pour voir la page de détails du produit API et invoquer l'API.
• Rejeter : Le développeur doit communiquer avec l'administrateur, apporter les ajustements nécessaires en fonction des commentaires, et soumettre à nouveau la demande.

Conclusion

API7 Enterprise intègre la plateforme de passerelle API avec un portail développeur pour créer une solution de gestion d'API efficace pour les fournisseurs et les développeurs d'API.

Le Portail Fournisseur API7 permet aux fournisseurs d'API de publier, gérer et surveiller facilement les produits API tout en coordonnant efficacement les ressources des développeurs. Pendant ce temps, les développeurs peuvent comprendre, intégrer et utiliser efficacement les services API, accélérant ainsi le développement des applications. Ces deux portails travaillent en synergie pour rationaliser le processus de gestion du cycle de vie des API, rendant chaque étape, du déploiement à l'invocation, plus fluide et plus efficace.