Aller au contenu principal

API et Webhooks

Vous pouvez intégrer VaultysHub avec n'importe quel logiciel (LDAP, SOC, Google Suite, ...) via l'API VaultysHub et les Webhooks !

Ces fonctionnalités sont disponibles pour les licences Platinum et Enterprise uniquement.

L'API VaultysHub vous permet d'effectuer des requêtes vers votre VaultysHub (ex : récupérer les apps, créer des utilisateurs, ...) pour vos intégrations.

Les webhooks permettent d'envoyer des données vers l'URL de votre choix lorsque des événements sont déclenchés (ex : création d'un utilisateur, connexion d'un utilisateur, ...).


Webhooks​

Accéder à l'onglet Webhooks​

Rendez-vous dans Configuration depuis la barre de navigation latérale, puis sélectionnez l'onglet Webhooks.

Rendez-vous dans Configuration puis dans l'onglet Webhooks

01.webhooks-tab-overview

Documentation des webhooks​

Cliquez ici pour acceder a la documentation complete des webhooks VaultysHub (liste des evenements disponibles, format des payloads, ...)

Cliquez sur le lien Open VaultysHub Webhooks documentation pour accéder à la documentation complète des webhooks : liste des événements disponibles, format des payloads, exemples d'intégration.

Ajouter un endpoint​

Cliquez sur le bouton Ajouter un endpoint dans la barre d'outils pour configurer un nouveau webhook.

Cliquez sur Ajouter un endpoint pour configurer un nouveau webhook

Un panneau latéral s'ouvre avec le formulaire de configuration.

04.add-endpoint-form

Configurer l'endpoint​

URL de destination​

Saisissez l'URL de votre endpoint. VaultysHub enverra les evenements HTTP POST a cette adresse.

Saisissez l'URL de votre endpoint. VaultysHub enverra les événements en HTTP POST à cette adresse.

Événements à écouter​

Selectionnez les evenements que vous souhaitez ecouter (creation d'utilisateur, connexion, ...)

Sélectionnez les événements que vous souhaitez recevoir. Vous pouvez en choisir plusieurs simultanément.


API​

Accéder à l'onglet API​

Depuis l'onglet API de la page Configuration, vous pouvez activer l'accès à l'API REST VaultysHub.

07.api-tab---disabled

Par défaut, l'API est désactivée.

Le bandeau indique l'etat actuel de l'API. Ici l'API est desactivee.

Activer l'API​

Activez ce switch dans la barre d'outils pour activer l'API VaultysHub

Activez le switch Activer l'API dans la barre d'outils pour activer l'accès à l'API.

10.api-tab---enabled

Une fois l'API activée, votre clé API s'affiche.

Clé API​

La cle API apparait masquee. Passez la souris dessus pour la reveler.

La clé API est masquée par défaut. Passez la souris dessus pour la révéler.

Copier la clé​

Cliquez sur Copier pour copier la cle API dans le presse-papier

Cliquez sur Copier pour copier la clé API dans le presse-papier et l'utiliser dans vos intégrations.

Régénérer la clé​

Cliquez sur Regenerer pour creer une nouvelle cle API. L'ancienne cle sera immediatement invalidee.

Cliquez sur Régénérer pour créer une nouvelle clé API. L'ancienne clé sera immédiatement invalidée — pensez à mettre à jour toutes vos intégrations.

Documentation de l'API​

Cliquez ici pour ouvrir la documentation interactive de l'API VaultysHub (Swagger)

Cliquez sur Ouvrir la documentation de l'API VaultysHub pour accéder à la documentation interactive (Swagger) listant tous les endpoints disponibles.

15.api-documentation-page