Cet article explique comment configurer les identités API dans FM.
Utiliser une identité API permet un accès granulaire à l'API Dalux FM, en utilisant les rôles d'utilisateur existants et la logique de région. Cela permet de restreindre l'accès API uniquement aux données nécessaires.
Lire la suite
Pour plus d'informations sur les API Dalux, lisez cet article : Dalux API.
Comment configurer les identités API
Informations techniques
Les identités API peuvent être utilisées pour l'accès à l'API Dalux FM à partir de la version 2.0.0 et suivantes.
Les identités API peuvent seulement être créées et gérées par les administrateurs dans l'instance FM.
L'identité API ne peut pas utiliser un email déjà associé à un utilisateur enregistré ou invité dans Dalux FM. De même, un email pour une identité API ne peut pas être utilisé pour un utilisateur Dalux FM.
Pour créer une identité API, allez à :
Réglages
Intégrations
'Identités API':
Pour créer une nouvelle identité API, cliquez sur Ajouter.
-
Type d'identité - Vous avez deux choix
- Général - Accès direct aux données dans l'instance FM
- Entreprise - Accès fournisseur externe aux données, tel que configuré dans les réglages de l'entreprise
- Nom - Nom de l'identité API (peut être modifié plus tard)
- Email - Email utilisé pour les communications concernant les services API Dalux et l'utilisation de l'identité API (ne peut pas être modifié une fois l'identité API créée)
- Administrateur - Remplace l'autorisation de tout rôle d'utilisateur et donne accès à toutes les données. Pour le type d'identité 'Entreprise', cela donne un accès d'administrateur d'entreprise.
- Description - Une description optionnelle pour l'identité API pour vous aider et aider les autres plus tard
Après avoir rempli les informations requises, lu et accepté les termes et conditions, cliquez sur 'Créer' pour continuer la configuration de l'identité API.
Note
Les clés API ne sont pas générées tant que vous ne les ajoutez pas à l'identité API plus tard dans le processus.
Vous pouvez maintenant attribuer des rôles d'utilisateur et des régions à l'identité API. Cela détermine quelles données sont accessibles via l'API. Par exemple, vous ne pouvez pas accéder aux données des ordres de travail si les rôles d'utilisateur affectés n'ont pas accès aux ordres de travail.
Si l'identité API dispose d'autorisations d'administrateur, elle remplace toutes les autorisations des rôles d'utilisateur et donne accès à toutes les données.
Pour ajouter des rôles d'utilisateur et des régions à l'identité API, cliquez sur 'Ajouter' dans la zone des rôles d'utilisateur.
Vous pouvez ajouter des rôles d'utilisateur seuls, ou spécifier également une région pour le rôle d'utilisateur.
Une fois que vous avez ajouté vos rôles d'utilisateur, vous pouvez commencer à créer des clés API. Pour créer des clés API pour l'identité API, cliquez sur 'Ajouter' dans la zone des clés API. Lorsque vous créez une clé API, vous devez spécifier la durée d'expiration de la clé.
Lorsque vous cliquez sur 'Ajouter', la clé API sera générée.
Copiez la clé et distribuez-la conformément aux conditions générales. L'identité API peut maintenant utiliser sa clé API, limitée à l'API spécifiée par l'accès du rôle d'utilisateur.
Lire la suite
Pour plus d'informations sur les API Dalux, lisez cet article : Dalux API.