Présentation du processus de publication

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

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éer des produits d'API qui regroupent vos API.
  2. Inscrire les développeurs d'applications.
  3. Enregistrer des applications de développeur.
  4. Fournir la documentation et l'assistance de la communauté concernant vos API.

Tâche 1 : créer un produit d'API

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. Vous créez des produits d'API à l'aide de l'API ou de l'interface utilisateur Apigee. (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 gratuit 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 gratuite, 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.

N'oubliez pas qu'Apigee vous permet de créer des produits d'API qui répondent aux exigences commerciales de votre entreprise.

Pour plus d'informations sur la création de produits d'API, consultez la page Gérer des produits d'API.

Tâche 2 : enregistrer un développeur d'applications

Un développeur crée les applications qui utilisent vos API. Un développeur d'application doit s'inscrire sur Apigee avant de pouvoir enregistrer son application. Lorsqu'il enregistre son application, il reçoit une clé API qui lui donne accès à 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 d'Apigee pour l'enregistrer manuellement. Pour en savoir plus, consultez la page Enregistrer des développeurs d'applications.

Tâche 3 : enregistrer une application de développeur

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

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.

Lorsqu'une application est enregistrée sur Apigee, Apigee lui attribue une clé API unique qu'elle doit transmettre dans toutes les requêtes adressées à 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.
  • Utiliser l'API Apigee pour intégrer la fonctionnalité d'enregistrement d'applications et d'envoi de clés à votre site Web.
  • Pour un compte Apigee payant, utilisez le portail de services dédiés aux développeurs Apigee, qui est compatible avec l'enregistrement d'applications et l'envoi de clés API.

Pour plus d'informations, consultez la page Enregistrer des applications et gérer les 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 disposez d'un compte Apigee payant, vous pouvez utiliser le portail de services dédiés aux 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

Pour en savoir plus, consultez les sections suivantes :