Création d'un jeton d'accès API Workvivo
Chaque requête vers l’API Workvivo doit inclure un jeton porteur dans son en-tête d’autorisation. Cet article explique comment créer une application, attribuer les autorisations requises et générer un jeton porteur.
- Crée une application dans Workvivo.
- Attribue les autorisations et les portées requises par ton intégration.
- Génère et stocke un jeton porteur en toute sécurité.
Exigences
Appareil : ordinateur de bureau
Rôle : développeur
Disponibilité : l'accès à l'API doit être activé par l'assistance Workvivo.
- Contacte le support Workvivo pour demander un accès API pour ton organisation.
- Après l’activation de l’accès à l’API, un administrateur de compte doit accorder à l’utilisateur le rôle de développeur. Voir Attribution de rôles dans Workvivo.
Les utilisateurs ayant le rôle de développeur peuvent accéder aux clés API et paramètres JWT depuis le menu Administration. De là, ils peuvent créer des applications, gérer les autorisations de l’intégration et générer des jetons porteurs.
Créer une application et générer un jeton
1. Ouvre les clés API et les paramètres JWT
Ouvre Administration, puis sélectionne clés API et paramètres JWT.
2. Ajoute une application
Sélectionne Ajouter une nouvelle application.
3. Nomme l'application et attribue les champs d'application
Saisis un nom clair pour l’application et sélectionne les autorisations requises par ton intégration. Consulte la documentation de l’API pour identifier les autorisations requises pour chaque point de terminaison. Par exemple, une intégration utilisant l’API Teams doit avoir les autorisations de lecture ou d’écriture requis de Teams.
Conseil : tu peux mettre à jour les autorisations de l'application plus tard en fonction de l'évolution des besoins.
4. Gère les clés de l’application
Après avoir créé l’application, sélectionne Gérer les clés.
5. Génère le jeton porteur
Sélectionne Ajouter une nouvelle clé, puis saisis un nom pour la clé. Workvivo générera et affichera le jeton porteur.
Important : copie le jeton et stocke-le en toute sécurité avant de fermer la fenêtre. Le jeton ne peut pas être récupéré à nouveau après la fermeture de la fenêtre.
Si un jeton est exposé ou a pu être compromis, supprime immédiatement sa clé et génères-en un nouveau.
Informations complémentaires
- Consulte la documentation pour développeurs de Workvivo pour connaître les points de terminaison disponibles et les champs d'application requis.
- L'accès à l'API n'est pas activé pour tous les comptes Workvivo. Contacte le support Workvivo si tu as besoin d’y accéder.