Vue d'ensemble du processus de publication

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Le processus de publication consiste à mettre vos API à la disposition des développeurs d'applications afin qu'ils puissent les utiliser.

Vidéo : la vidéo suivante fournit une présentation générale de la publication d'API.

La publication d'API implique les tâches ci-dessous, décrites dans cet article :

  1. Créez sur Edge les produits d'API qui regroupent vos API.
  2. Enregistrez les développeurs d'applications sur Edge.
  3. Enregistrez des applications de développement sur Edge.
  4. Fournir la documentation et l'assistance de la communauté concernant vos API.

Tâche 1: Créer un produit API sur Edge

En publication, la première tâche consiste à créer un produit d'API. Un produit d'API est un ensemble de ressources d'API proposées aux développeurs d'applications sous forme de package. Créez des produits d'API à l'aide de l'API ou de l'interface utilisateur de gestion Edge. (Consultez la section Qu'est-ce qu'un produit d'API ? pour en savoir plus sur les produits d'API.)

Diagramme séquentiel illustrant de gauche à droite montrant un développeur, une application, des API et des services de backend. L'icône et les ressources de l'API sont mises en évidence. Ligne pointillée partant du développeur vers l'icône d'une application qu'il a créée Les flèches orientées vers et depuis l'application représentent les flux de requêtes et de réponses envoyées à une icône d'API, avec une clé d'application placée au-dessus des requêtes. L'icône et les ressources de l'API sont mises en évidence. Sous l'icône d'API, deux ensembles de chemins de ressources sont regroupés dans deux produits d'API : un produit Localisation et un produit Multimédia. Le produit Localisation comporte des ressources pour les /pays, /villes et /langues, tandis que le produit Multimédia propose des ressources pour les /livres, /magazines et /films. À droite de l'API se trouvent les ressources backend que l'API appelle, telles qu'une base de données, un bus de service d'entreprise, des serveurs d'applications et un backend générique.

Dans cette figure, l'API se compose de deux produits, chacun contenant trois ressources d'API.

En tant que fournisseur d'API, vous êtes responsable de la création des API et des produits d'API permettant de gérer le contrôle des accès, les restrictions d'utilisation et toute autre exigence commerciale. Vous pouvez, par exemple, mettre à disposition les produits suivants :

  • Un produit d'API sans frais permettant d'accéder en lecture seule aux ressources API qu'il contient.
  • Un deuxième produit d'API à moindre coût permettant d'accéder en lecture/écriture aux mêmes ressources d'API que la version sans frais, mais avec une limite d'accès faible, telle que 1 000 requêtes par jour.
  • Un troisième produit d'API à un prix plus élevé permettant d'accéder en lecture/écriture à la même ressource API, mais avec une limite d'accès élevée.

Le point important à retenir est qu'Edge vous donne la flexibilité de créer des produits d'API qui répondent aux exigences commerciales de vos API.

Pour plus d'informations sur la création de produits d'API, consultez Créer des produits d'API.

Tâche 2: Enregistrer un développeur d'applications sur Edge

Un développeur crée les applications qui utilisent vos API. Un développeur d'applications s'enregistre sur Apigee Edge avant de pouvoir enregistrer son application. Lorsqu'il enregistre son application, il reçoit une clé API qui lui permet d'accéder à l'API.

Le processus d'enregistrement de l'application vous permet de contrôler qui a accès à vos API. Vous pouvez à tout moment supprimer un développeur d'applications. Cette action invalide toutes les clés API associées à ce développeur et lui interdit d'accéder à vos API.

Diagramme séquentiel illustrant de gauche à droite montrant un développeur, une application, des API et des services de backend. L'icône du développeur est mise en évidence. Ligne pointillée partant du développeur mis en évidence vers l'icône d'une application qu'il a créée Les flèches orientées vers et depuis l'application représentent les flux de requêtes et de réponses envoyées à une icône d'API, avec une clé d'application placée au-dessus des requêtes. Sous l'icône d'API, deux ensembles de chemins de ressources sont regroupés dans deux produits d'API : un produit Localisation et un produit Multimédia. Le produit Localisation comporte des ressources pour les /pays, /villes et /langues, tandis que le produit Multimédia propose des ressources pour les /livres, /magazines et /films. À droite de l'API se trouvent les ressources backend que l'API appelle, telles qu'une base de données, un bus de service d'entreprise, des serveurs d'applications et un backend générique.

En tant que fournisseur d'API, vous décidez de la procédure à suivre pour inscrire les développeurs. Par exemple, vous pouvez utiliser un processus d'inscription manuel qui oblige un développeur potentiel à contacter votre organisation pour s'inscrire. Le développeur potentiel doit fournir toutes les informations nécessaires, par exemple, une adresse e-mail, un prénom et un nom d'entreprise. Si vous approuvez la demande du développeur, vous pouvez utiliser l'interface utilisateur de gestion Edge pour enregistrer manuellement le développeur. Pour en savoir plus, consultez Gérer les développeurs d'applications.

Apigee fournit également des outils que vous pouvez utiliser pour automatiser le processus d'inscription des développeurs. Exemple :

  • Utilisez l'API de gestion Apigee Edge pour intégrer la fonctionnalité d'enregistrement à votre site Web existant. L'API de gestion Edge est une API REST que vous pouvez utiliser pour effectuer tous les aspects du processus d'enregistrement des développeurs. Pour en savoir plus, consultez la section Utiliser l'API de gestion Edge pour publier des API.
  • Utilisez le portail de services pour les développeurs Apigee pour enregistrer les développeurs. Le portail permet l'enregistrement des développeurs, mais offre également de nombreuses autres fonctionnalités pour vos API. Pour en savoir plus, consultez la page Qu'est-ce qu'un portail des développeurs ?.

Tâche 3: Enregistrer une application de développement sur Edge

Pour qu'une application puisse accéder à vos API, elle doit être enregistrée sur Edge. Cependant, seul un développeur inscrit peut enregistrer une application sur Edge.

Diagramme séquentiel illustrant de gauche à droite montrant un développeur, une application, des API et des services de backend. L'application, les flèches représentant les flux de requêtes/réponses et la clé API sont mises en évidence. Ligne pointillée partant du développeur vers l'icône d'une application qu'il a créée Les flèches orientées vers et depuis l'application représentent les flux de requêtes et de réponses envoyées à une icône d'API, avec une clé d'application placée au-dessus des requêtes. L'icône et les ressources de l'API sont mises en évidence. Sous l'icône d'API, deux ensembles de chemins de ressources sont regroupés dans deux produits d'API : un produit Localisation et un produit Multimédia. Le produit Localisation comporte des ressources pour les /pays, /villes et /langues, tandis que le produit Multimédia propose des ressources pour les /livres, /magazines et /films. À droite de l'API se trouvent les ressources backend que l'API appelle, telles qu'une base de données, un bus de service d'entreprise, des serveurs d'applications et un backend générique.

Au moment d'enregistrer l'application, le développeur sélectionne un ou plusieurs produits d'API. Par exemple, vous pouvez publier plusieurs produits d'API correspondant à différents types de services et forfaits. Le développeur de l'application peut alors choisir et sélectionner les produits d'API disponibles dans la liste.

En réponse à l'enregistrement de l'application sur Edge, Edge attribue une clé API unique à l'application. L'application doit transmettre cette clé API dans chaque requête adressée à une ressource API. La clé est authentifiée et, si elle est valide, la requête est accordée. En tant que fournisseur de services, vous pouvez révoquer la clé à tout moment afin que l'application ne puisse plus accéder à vos API.

En tant que fournisseur d'API, vous devez choisir la façon dont vous souhaitez enregistrer les applications. Vous pouvez :

  • Utiliser un processus manuel qui oblige un développeur à contacter votre organisation pour enregistrer son application. En réponse, vous envoyez la clé API au développeur, par e-mail, éventuellement.
  • Utilisez l'API de gestion Edge pour intégrer la fonctionnalité d'enregistrement d'applications et la distribution des clés à votre site Web.
  • Pour un compte Edge payant, utilisez le portail de services pour les développeurs Apigee qui permet l'enregistrement d'applications et la livraison de clés API.

Pour en savoir plus, consultez la page Enregistrer des applications et gérer des clés API.

Tâche 4 : fournir la documentation sur vos API

La mise à disposition de la documentation et d'un mécanisme permettant aux développeurs de fournir des commentaires sont des éléments importants à prendre en compte pour publier des produits d'API. Les portails pour développeurs qui fournissent des fonctionnalités de publication sur les réseaux sociaux sont de plus en plus utilisés pour communiquer avec la communauté de développement. Ces échanges comprennent également la communication de contenus statiques, tels que la documentation sur l'API et les conditions d'utilisation, de contenus dynamiques envoyés par la communauté, comme les blogs et les forums, ainsi que de fonctionnalités de service client.

Diagramme séquentiel illustrant de gauche à droite montrant un développeur, une application, des API et des services de backend. L'icône du développeur est mise en évidence. Le cadre situé sous le développeur représente un portail pour développeurs. Ce portail contient la documentation, les exemples, les tutoriels, la documentation de référence sur l'API, etc. Il contient également des blogs, des forums et un portail d'assistance. Ligne pointillée partant du développeur mis en évidence vers l'icône d'une application qu'il a créée Les flèches orientées vers et depuis l'application représentent les flux de requêtes et de réponses envoyées à une icône d'API, avec une clé d'application placée au-dessus des requêtes. Sous l'icône d'API, deux ensembles de chemins de ressources sont regroupés dans deux produits d'API : un produit Localisation et un produit Multimédia. Le produit Localisation comporte des ressources pour les /pays, /villes et /langues, tandis que le produit Multimédia propose des ressources pour les /livres, /magazines et /films. À droite de l'API se trouvent les ressources backend que l'API appelle, telles qu'une base de données, un bus de service d'entreprise, des serveurs d'applications et un backend générique.

Vous pouvez créer votre propre site Web pour déployer votre documentation ou, si vous possédez un compte Edge payant, vous pouvez utiliser le portail des services pour les développeurs Apigee. Ce portail est compatible avec la documentation, les blogs, les forums et les autres types de contenus nécessaires au soutien de votre communauté de développeurs.

SmartDocs vous permet de mettre à disposition la documentation de vos API sur le portail de services dédiés aux développeurs de manière entièrement interactive. Grâce à la documentation SmartDocs interactive, les utilisateurs du portail peuvent :

  • En savoir plus sur l'API
  • Envoyer une requête en direct à l'API
  • Afficher une réponse en direct renvoyée par l'API

Par exemple, la figure suivante montre une API documentée sur le portail à l'aide de SmartDocs. Cette API fournit des informations météorologiques pour un lieu spécifique:

Rubrique de méthode SmartDocs pour appeler une API météo en cliquant sur un bouton du sujet.

Le développeur saisit une valeur pour le paramètre de requête "w" pour spécifier l'emplacement, puis clique sur le bouton Send the request (Envoyer la requête) pour afficher la requête et la réponse en direct. En créant une documentation interactive sur vos API, vous aidez l'utilisateur du portail à apprendre, tester et évaluer facilement vos API.

L'API de gestion Edge est une API REST qui vous permet d'accéder aux services d'API à l'aide de n'importe quel client HTTP. Apigee utilise SmartDocs pour créer une documentation interactive pour l'API de gestion Edge. Pour consulter la documentation de l'API, cliquez ici.

Pour en savoir plus, consultez la section Utiliser SmartDocs pour documenter des API.