Aller au contenu principal

Raccorder et exposer son API

Suite à votre inscription sur Okapi et l'activation de votre compte en tant que fournisseur d'API, voici maintenant les étapes à suivre pour raccorder et exposer votre API (si vous n'avez pas encore de compte fournisseur, rendez-vous sur la page des premiers pas d'un fournisseur d'API).

1. Choisir le mode de saisie des informations​

Vous pouvez raccorder votre API :

  • En utilisant l'interface web (vivement conseillé). Ce mode opératoire est conseillé lors de la création d'une API ou pour apporter des modifications à celle-ci.
  • En injectant un fichier de configuration YAML (mode expert). Ce mode opératoire est réservé aux utilisateurs avertis. Il permet notamment d'ajouter des paramètres avancés sur une API existante.

2. Raccorder son API​

2.1. Via l'interface web​

Rendez-vous sur Okapi et connectez-vous

Cliquez sur le picto du profil en haut à droite et sélectionnez « Gérer mes API »

Cliquez sur « Ajoutez une API »

Suivez le formulaire qui vous guidera pour renseigner les informations techniques (votre URL de production, votre URL de test…) et marketing (nom, version, visuel, descriptions…) de l'API.

Puis, toujours dans l'espace « Gérer mes API », vous pourrez ensuite :

  • Gérer les utilisateurs autorisés à accéder à l'API (si celle-ci est privée).
  • Renseigner vos ressources.
  • Gérer vos offres et leurs utilisateurs.
    Par défaut, à l'enregistrement du formulaire, une offre publique, gratuite et illimitée est créée. Vous pouvez la modifier, la supprimer, rajouter des offres publiques (souscription libre) ou privées (souscription après autorisation), limitées ou non, payantes ou non… Sur chaque offre, vous pouvez visualiser et gérer les utilisateurs
  • Saisir ou importer la documentation (format de saisie ou d'import markdown).
  • Importer la documentation Swagger (format d'import JSON ou YAML).

2.2. En injectant un fichier de configuration YAML​

Les informations de base ayant été renseignées dans l'étape précédente, vous pouvez maintenant les compléter par des fonctionnalités avancées

Rendez-vous sur Okapi et connectez-vous

Cliquez sur le picto du profil en haut à droite et sélectionnez « Gérer mes API »

Sélectionnez l'API que vous souhaitez modifier

Exportez le fichier de configuration YAML de l'API

Modifiez / complétez le fichier avec les paramètres souhaités des fonctionnalités avancées.

Importez le fichier depuis la page « Importer des données ».

3. Authentifier Okapi comme consommateur de votre API​

En tant qu'API Manager, Okapi deviendra l'unique consommateur de vos APIs. Si la consommation de votre API est soumise à une authentification préalable, il faudra renseigner les données nécessaires à l'authentification d'Okapi auprès de votre API dans le fichier YAML (cf. point 2.2). Okapi supporte nativement les méthodes d'authentification suivantes :

Si votre autorité de certification n'est pas incluse dans les truststores des OS/Navigateurs, merci de nous la fournir afin que nous l'autorisions.

Un doute, une question ?
L'équipe Okapi est à votre disposition pour vous accompagner.

developer.laposte.frNous contacter