# Créer son connecteur API

Vizir propose à ses clients des connecteurs natifs pour de nombreuses applications mais vous pouvez créer vos propres connecteurs pour:

  • un usage interne avec des actions disponible seulement sur certains bots
  • distribuer votre application à tous les utilisateurs de Vizir

# Créer son application

Pour créer son application il faut se rendre dans la partie Connexion API du dashboard sur votre compte Vizir.

Vous verrez alors apparaitre la liste de tous les intégration publiques Vizir et de vos intégration privées.

Pour créer une nouvelle intégration: cliquez sur Faire une demande d'intégration

Dans la fenêtre de droite renseignez les champs tel qu'ils vous sont demandés.

Validez la création de l'application. La nouvelle application apparait dans la liste des application. On va maintenant pouvoir l'éditer en cliquant sur la le bouton d'édition

Sur la droite de l'écran s'ouvre alors l'éditeur qui va vous permettre de paramétrer la nouvelle intégration. Voici la liste des champs qu'il faudra compléter:

  • Url de base de l'api: C'est le hostname de l'api, chaque action aura ensuite sa propre route à partir de ce hostname.
  • Is the app ready for production: Ce champs vous permet de rendre accessible l'intégration dans les workflow. Tant que l'intégration n'est pas prête à être utilisé vous pouvez le laisser false.
  • Usage interne: Si vous souhaitez que votre intégration soit disponible pour tous les utilisateurs de Vizir, vous pouvez activer cette option. Dans le cas contraire elle sera accessible sur votre chatbot par vous et les autres éditeurs du chatbot.

Ensuite nous passons à la partie sur l'authentification.

  • Type d'authentification: Vizir supporte pour le moment 3 types d'authentification standard: Oauth2, Oauth1, et Basic Auth

En fonction du type d'authentification choisie vous aurez à renseigner des paramètres qui seront disponible dans l'application tierce à laquelle vous souhaitez connecter Vizir.

Lorsque vous avez validé votre intégration, vous pouvez maintenant y ajouter des actions.

Créer mes actions (opens new window)

# API avec le protocol Oauth 2

Si vous ne souhaitez pas ajouter toutes les actions d'une API, vous pouvez vous simplifiez la vie et en créer une seule action de type "webhook" que vos utilisateurs pourront personnaliser pour exécuter toutes les actions.

Voici un exemple

  • Créer l'intégration API en suivant le guide sur la création d'une intégration (voir la doc (opens new window))
  • Ajouter une première (et dernière) action.
  • Renseigner tous les champs comme ci dessous

path: vous pouvez définir le path comme étant une variable. Etant donné qu'il va très certainement contenir des "/" ne pas oublier de mettre 3 accolades.

method: Sélectionnez pour laisser la possibilité à vos utilisateurs de modifier le type de requête

Pour le payload, indiquez simplement {body} pour permettre à l'utilisateur de formatter lui même le body de la requête.

Enfin laissez vide le champ de réponse car la réponse sera différente en fonction du chemin API utilisé.

Ensuite cliquez sur Voir les paramètres de l'action pour personnaliser le type de champs de:

  • path (input type: input, vendor type: string)
  • request_type (Input type: input, vendor type: string)
  • body (input type: json, vendor type: object)

Une fois validée vous pouvez profitez de la connection à l'API Oauth2 pour toutes les routes API.