Compliance API & Webhooks
Connectez vos données de conformité à d’autres systèmes : donnez-leur un jeton d’API pour lire les contrôles, les risques et les preuves, et envoyez des événements à Slack, à Teams ou à votre propre point de terminaison au moment où ils se produisent.
À quoi sert la page
Compliance API & Webhooks est une page de la console Lavawall®, dans la section Conformité (GRC). Lavawall est la plateforme de RMM, de sécurité et de conformité de ThreeShield, conçue et hébergée au Canada. À propos de cette fonctionnalité.
Les jetons d’API permettent à un autre système, comme un outil de gestion de tickets ou un tableau de bord de rapports, de lire les données de conformité de cette entreprise ou de créer des tâches et de lier des preuves. Chaque jeton a des portées qui limitent ce qu’il peut faire et expire au bout d’un an au plus. Un jeton n’est affiché qu’une seule fois, au moment de sa création.
Les webhooks envoient un message HTTPS à l’adresse de votre choix chaque fois qu’un événement de conformité sélectionné se produit. Les adresses de webhook entrant de Slack et de Microsoft Teams reçoivent un court message texte; toute autre adresse reçoit un document JSON signé. Les livraisons échouées sont reprises automatiquement, et chaque livraison est consignée.
Un troisième onglet, Using the API, documente les requêtes et explique comment vérifier la signature d’un webhook.
Ce que vous voyez
- Tabs (onglets) : API tokens, Webhooks et Using the API.
- New token / New webhook : le bouton d’ajout en haut de chaque onglet.
- Tokens and webhooks tables (tableaux de jetons et de webhooks) : API tokens : Nom, Token (prefix only), Scopes, Created, Last used, Expires, State et Révoquer. Webhooks : Address (masked), Format, Events, Last delivery, Waiting, State, avec Tester, Log (le journal des livraisons, avec Retry) et More (Edit address or events, Switch off or on, Rotate secret, Supprimer).
- Webhook editor (éditeur de webhook) : Address (https) et Events, avec Tout sélectionner.
Comment utiliser Compliance API & Webhooks
Comment créer un jeton d’API
- Sous API tokens, sélectionnez New token.
- Saisissez un Nom qui indique ce qui l’utilise, par exemple « Synchronisation du système de tickets ».
- Choisissez les Scopes. read est coché par défaut; ajoutez write:tasks ou write:evidence seulement au besoin.
- Choisissez Expires after : 30 jours, 90 jours (valeur par défaut), 180 jours ou 1 an (le maximum).
- Sélectionnez Create token, puis copiez le jeton. Sélectionnez I have copied it lorsque vous avez terminé; il ne sera plus affiché.
Comment révoquer un jeton
- Sélectionnez Révoquer dans la ligne du jeton et confirmez. Tout ce qui l’utilise cesse aussitôt de fonctionner.
Comment envoyer des événements de conformité à Slack ou à Teams
- Sous Webhooks, sélectionnez New webhook.
- Collez l’adresse du webhook entrant de Slack ou de Teams dans Address (https).
- Cochez les Events voulus, ou Tout sélectionner.
- Sélectionnez Enregistrer et copiez le secret de signature, qui n’est affiché qu’une seule fois.
- Sélectionnez Tester pour envoyer un message d’essai.
Comment vérifier ou reprendre les livraisons
- Sélectionnez Log sur le webhook.
- Pour une livraison échouée, sélectionnez Retry. Elle est envoyée lors du prochain cycle de livraison.
Comment renouveler le secret de signature d’un webhook
- Sélectionnez More, puis Rotate secret, et confirmez.
- Copiez le nouveau secret et mettez à jour le système récepteur; celui-ci rejette les livraisons tant qu’il n’a pas le nouveau secret.
Conseils
- Traitez les adresses de webhook de Slack et de Teams comme des secrets. Après l’enregistrement, l’adresse est masquée et ne peut plus être affichée; saisissez-en une nouvelle seulement pour la remplacer.
- Les adresses de webhook doivent être accessibles sur Internet par HTTPS, sur le port 443 ou 8443. Les adresses de réseau privé sont refusées.
- Les livraisons échouées sont reprises après 1 minute, 5 minutes, 30 minutes, 2 heures et 12 heures. Après 20 échecs consécutifs, le webhook est désactivé et son créateur reçoit un courriel.
- Chaque livraison comporte un en-tête X-Lavawall-Signature; l’onglet Using the API explique comment le vérifier.
- Les réponses de l’API utilisent l’heure UTC et sont paginées avec une limite de 1 à 200 éléments par requête.
Dépannage
- « Only a GRC administrator can manage API tokens and webhooks for this company. »
- : demandez à un administrateur GRC, ou faites modifier votre rôle GRC dans Paramètres de conformité.
- « This company already has 25 active tokens. »
- : révoquez-en un que vous n’utilisez plus.
- « This company already has 10 webhooks. »
- : supprimez-en d’abord un.
- « That is ten test messages in ten minutes. »
- : attendez quelques minutes avant de refaire un essai.
- « Test not delivered »
- : le récepteur n’a pas accepté le message. Vérifiez l’adresse et que le service récepteur est en fonction.
Articles connexes
Besoin d’aide supplémentaire?
Consultez le centre de soutien ou communiquez avec notre équipe de soutien en nous indiquant la page où vous vous trouviez :
- Clavardage : utilisez le bouton de clavardage dans le coin inférieur droit de cette page pour joindre notre équipe immédiatement. Lorsque le consentement aux témoins est requis, le clavardage démarre après votre acceptation (paramètres des témoins).
- Courriel : envoyez un message à notre équipe de soutien par la page Nous joindre. Il est transmis directement à une personne.
- Téléphone : AB : 1-403-538-5053, C.-B. : 1-778-731-1339, ON : 1-289-724-8829, É.-U. : 1-406-988-7333, R.-U. : +44 20 3695 9786.
Les noms, entreprises, appareils et chiffres figurant dans les images sont des exemples. Les autres noms de produits et d’entreprises sont des marques de commerce de leurs propriétaires respectifs.