Présentation
Les intégrations personnalisées sont utilisées par les clients de Workplace pour le développement interne (ou le développement sur mesure à l’usage exclusif d’un(e) seul(e) client(e) de Workplace) afin d’intégrer leurs propres outils ou écosystème logiciel à Workplace.
Dans cette section, nous allons découvrir comment créer et configurer une intégration personnalisée sur Workplace.
Créer une intégrationCréer une intégration
Pour créer une intégration, vous devez vous connecter en tant qu’admin et avoir l’autorisation Modifier les paramètres de l’entreprise et configurer les intégrations. Une fois connecté(e), vous pouvez suivre les étapes suivantes pour créer une intégration :
Une fois l’intégration créée, vous pouvez procéder à sa configuration.
Configuration de base
Dans la section Intégrations du Panneau d’administration, cliquez sur le nom de l’intégration à configurer. Ce sont les champs que vous pouvez trouver sur l’écran de détails de l’intégration.
- Détails de l’intégration : vous pouvez modifier le nom, le logo et la description de l’intégration, consulter l’ID d’app et la clé secrète, ainsi que créer ou réinitialiser le token d’accès à votre intégration.
Le token d’accès est nécessaire pour envoyer toute requête d’API. Workplace peut ainsi vérifier et confirmer que l’intégration est bien à l’origine de ces requêtes. Il est fortement recommandé de sauvegarder le token d’accès dans un endroit sûr, car il peut être utilisé pour effectuer des actions critiques sur Workplace, comme la création ou la désactivation de comptes utilisateur (à condition que l’intégration dispose des autorisations correspondantes). - Visibilité : vous pouvez activer ou désactiver votre intégration. Si elle est désactivée, l’intégration ne pourra émettre aucune requête API.
Vous pouvez également activer ou désactiver sa visibilité afin qu’elle apparaisse dans la liste des bots disponibles sur Workplace. - Dernière requête de l’API : vous pouvez voir le dernier jour où l’intégration a émis une requête API et le nombre de requêtes émises au cours des sept derniers jours.
- Supprimer l’intégration : vous pouvez supprimer l’intégration. Cette action n’est pas réversible et supprimera l’intégration et son contenu associé.
Autorisations
Sur l’écran de configuration de l’intégration, il y a une section intitulée Autorisations où vous pouvez choisir les autorisations auxquelles votre intégration devra avoir accès. Vous trouverez ci-dessous la liste de ces autorisations.
Pour en savoir plus sur les autorisations d’intégration personnalisée, veuillez consulter la documentation pour les développeurs.
Webhooks
Il est également possible de configurer la section des webhooks pour chaque intégration. Les webhooks vous permettent de vous abonner à des évènements spécifiques et de recevoir des mises à jour en temps réel. Quand une modification est apportée dans Workplace, une requête HTTPS POST est envoyée à une URL de rappel pour chaque app d’intégration personnalisée abonnée au sujet de webhook pertinent.
Par exemple, un webhook peut recevoir une mise à jour dans l’URL de rappel lorsqu’un commentaire a été créé sous une publication.
Sujets
Les webhooks sont divisés par sujets, et vous pouvez définir une URL de rappel différente par sujet. Vous trouverez plus d’informations sur les sujets et les abonnements disponibles dans la documentation pour les développeurs.
S’abonner à un webhook
Vous trouverez plus d’informations sur la façon de vous abonner à un webhook et de l’utiliser dans la documentation pour les développeurs.
Sécurité
La dernière étape de la configuration d’une intégration est celle de la sécurité. Vous pouvez définir deux types de configurations ici :
- IP serveur autorisées : vous pouvez autoriser certaines adresses IP pour n’admettre que les appels d’API qui proviennent de celles-ci.
- Exiger une preuve de clé secrète : vous pouvez activer une couche de sécurité supplémentaire qui vous obligera à transmettre les détails de la clé secrète lors d’un appel d’API.