Pour générer une clé API publique et une clé privée pour Office Protect dans ConnectWise, vous devez vous connecter à votre plateforme ConnectWise Manage.
Vous pouvez alors soit :
- Recommandé – Générer des clés API publiques/privées pour un nouveau membre API à qui un rôle de sécurité personnalisé (autorisations restreintes/restricted permissions) est attribué – Commencer à l’étape 1.
- Générer des clés API publiques/privées pour un nouveau membre API à qui un rôle administrateur de sécurité est attribué (toutes les autorisations/all permissions) – Passez directement à l’étape 2.
Documentation ConnectWise sur les membres API :
- https://docs.connectwise.com/ConnectWise_Documentation/090/040/010/040
- https://docs.connectwise.com/ConnectWise_Support_Wiki/System/How_to_create_an_API_Member_and_API_Keys
1. Créer un nouveau rôle de sécurité
Vous pouvez soit accorder à Office Protect un rôle d’administrateur (passez à l’étape 2), soit créer un nouveau rôle personnalisé :
- Accédez à System > Security Roles
- Cliquez sur New Item
- Entrez un nouvel identifiant de rôle, p. ex. : « OfficeProtect »
- Cliquez sur Save
- Ajoutez les autorisations requises :
Par défaut, toutes les autorisations sont à « None ». Vous devez basculer 4 d’entre elles à « All ».
Autorisations requises :
Module | Autorisation | Ajouter un niveau | Modifier un niveau | Supprimer un niveau | Consulter un niveau |
Entreprises | Maintenance des entreprises | Aucune | Aucune | Aucune | Tous |
Centre de services | Billets de services | Tous | Tous | Aucune | Tous |
- Entreprises – Maintenance des sociétés – « Inquire All » nous permet de récupérer votre liste de sociétés afin que vous puissiez les mettre en relation avec des locataires.
- Centre de services – Billets de services – « Add All » nous permet de créer de nouveaux billets sur votre plateforme et « Edit All » nous permet de modifier ces billets. Ces autorisations ne peuvent être accordées sans l’autorisation « Inquire ».
Autorisations optionnelles :
Module | Autorisation | Ajouter un niveau | Modifier un niveau | Supprimer un niveau | Consulter un niveau |
Système | Configuration de tables | Aucune | Aucune | Aucune | Tous |
Système | Maintenance des membres | Aucune | Aucune | Aucune | Tous |
Ces deux autorisations permettent à Office Protect de récupérer le tableau de service par défaut de l’utilisateur API et la liste des statuts de billets, afin que la section « Ticket Creation Settings » (Paramètres de création de billets) puisse être affichée dans le formulaire de configuration.
- Cliquez sur Save.
Remarque : Il est possible que nous ayons besoin d’autres autorisations à l’avenir, au fur et à mesure de l’évolution du produit.
2. Ajouter un nouveau membre API
Après la création du nouveau rôle de sécurité :
- Accédez à System > Members
- Accédez à l’onglet Members de l’API et cliquez sur New Item
- Remplissez ce formulaire :
- Member ID (ID du membre), p. ex. : « OfficeProtect »
- Member Name (nom du membre), p. ex. : « OfficeProtect »
- Role ID (ID du rôle) : celui que vous avez précédemment créé « OfficeProtect » ou le rôle d’admin si vous n’avez pas créé un nouveau rôle de sécurité.
- Services par défaut (Service Defaults) : Dans la section Default board, sélectionnez le service dans lequel vous souhaitez qu’Office Protect crée vos événements. Si vous ne sélectionnez aucun tableau, les billets seront créés dans le tableau par défaut de ConnectWise.
- Si nécessaire, modifiez les valeurs par défaut des autres champs.
- Cliquez sur Save.
3. Créer de nouvelles clés API
Pendant que vous êtes sur la feuille de membre de l’API « OfficeProtect » fraîchement créée :
- Accédez à l’onglet API Keys.
- Cliquez sur New Item.
- Entrez la description de la clé API, par exemple « Intégration d’office Protect ».
- Cliquez sur Save : les clés publiques et privées doivent s’afficher sous la description.
Important : Veuillez à enregistrer la clé privée, car vous ne pourrez pas la récupérer après avoir fermé la page.