Connector Builder documentation d'autorisation
Une rubrique d'aide concernant l'autorisation doit inclure toute information pertinente qui permet à un utilisateur de créer et d'authentifier une connexion.
La première fois que les utilisateurs ajoutent votre connecteur à un flux, Workflows Oktales invite à configurer une connexion. Cette connexion est utilisée pour vérifier le compte ou l'environnement d'un utilisateur.
Conditions nécessaires
Dans la section Conditions nécessaires, précisez toutes les conditions qu'un utilisateur doit remplir avant de configurer une connexion. Par exemple, si un utilisateur doit générer une clé API ou configurer une intégration de l'app OAuth. Par exemple :
Exemple : Générer un jeton d'API
L'authentification à l'API Entreprise est contrôlée par des jetons de porteur au niveau de l'instance. Pour générer un jeton :
-
Connectez-vous et cliquez sur Paramètres.
-
Cliquez sur l'onglet Accès.
-
Localisez l'URL de l'API liée à votre instance.
-
Cliquez sur Ajouter pour créer une clé d'API.
-
Indiquez le Nom de votre jeton d'API.
-
Cliquez sur Enregistrer.
-
Dans la boîte de dialogue renfermant le jeton d'API , cliquez sur le symbole de visibilité pour afficher le jeton API.
-
Cliquez sur Copier pour copier le jeton d'API dans votre presse-papiers.
-
Cliquez sur Fermer.
Configurer une connexion
La rubrique Autorisation doit inclure des instructions sur la manière de créer une connexion à votre service. Par exemple :
Exemple : Créer une connexion
-
Sur la page Connexions, cliquez sur Nouvelle connexion.
-
Dans la boîte de dialogue Nouvelle connexion, ajoutez une chaîne à la boîte de dialogue Surnom de la connexion. Cette opération est utile lorsque vous créez plusieurs connexions à partager avec votre équipe.
-
Collez le jeton d'API créé de la section Conditions nécessaires dans le champ Jeton d'API.
-
Cliquez sur Créer.
Portées prises en charge
Pour l'authentification OAuth ou toute autre authentification par jetons, incluez une liste des permissions requises pour utiliser le connecteur. Si un élément quelconque est nécessaire pour configurer les permissions, incluez-le dans les sections des conditions nécessaires ou de la configuration. Par exemple :
Exemple : permissions prises en charge
-
https://www.googleapis.com/auth/userinfo.profile
-
https://www.googleapis.com/auth/userinfo.email
-
https://www.googleapis.com/auth/gmail.settings.basic
Exemples
À titre de référence, consultez ces rubriques Connector Builder sur les autorisations :
-
Autorisation pour le connecteur Box.
-
Autorisation pour le connecteur Freshservice.
Étapes suivantes