Guide d’automatisation : Configuration de nouveaux espaces clients via l’API
Emsisoft propose un ensemble complet d’API Web publiques qui peuvent être utilisées pour automatiser des tâches fréquemment effectuées, telles que :
-
Créer de nouveaux espaces clients
-
Inviter des utilisateurs et attribuer des rôles
-
Appliquer et activer des licences
-
Déployer le logiciel de protection
-
Assigner des appareils à des politiques de protection
-
Configurer des notifications par e-mail et webhook
Notre API est RESTful et renvoie du JSON. De nouvelles fonctionnalités sont ajoutées régulièrement.
La fonctionnalité de l’API Emsisoft reflète généralement les fonctionnalités de la console de gestion MyEmsisoft et du portail partenaire Emsisoft.
Consultez la documentation de l’API Emsisoft pour la référence complète.
Conditions préalables
La plupart des ressources de l’API Emsisoft nécessitent une clé API pour l’authentification. Si vous avez besoin d’une clé API, demandez-en une à votre gestionnaire partenaire Emsisoft via le formulaire de contact en bas à droite de cette page.
Les clés API sont associées aux comptes utilisateurs. Si votre niveau d’autorisation vous donne accès à une fonctionnalité spécifique via le portail web, vous pouvez vous attendre à avoir le même accès via l’API.
Notez que certaines fonctionnalités de l’API sont réservées aux partenaires Emsisoft enregistrés (par exemple : attribution de licences en stock aux espaces de travail) et que certaines sont uniquement disponibles pour les distributeurs Emsisoft (par exemple : création de nouvelles licences « à la volée »).
Créer un nouvel espace de travail
Un espace de travail Emsisoft définit une entité regroupant tous les appareils d’un client unique. Un espace de travail représente généralement une organisation, avec des groupes de politiques de protection et d’autorisations configurés pour refléter la structure interne de l’entreprise ou des départements.
En tant que partenaire Emsisoft, vous pouvez spécifier des paramètres tels que le nom de l’espace de travail, les rôles utilisateurs et les informations de licence dans un seul appel API, mais il est également possible d’ajouter ces informations étape par étape via des appels API individuels.
Appel API tout-en-un
Enregistrez un fichier texte create.json
contenant tous les détails de l’espace de travail. Remplacez les données d’exemple par vos valeurs souhaitées :
Ces valeurs d’exemple invitent votre client à rejoindre le nouvel espace de travail en tant que propriétaire, vous ajoutent en tant qu’administrateur de l’espace, attribuent l’un de vos coupons de licence inutilisés et garantissent qu’Emsisoft ne contactera pas vos clients directement pour les renouvellements.
Il est également possible d’assigner une licence d’essai pour une édition spécifique du produit ou d’ajouter l’espace de travail à votre plan de facturation mensuelle MSP.
Exécutez cette commande POST pour effectuer l’action :
Vous devriez recevoir un code HTTP 200 confirmant la création réussie de l’espace de travail. Vérifiez les éventuelles erreurs :
-
HTTP 400 – Requête incorrecte / Erreur de validation ou logique
-
HTTP 401 – Non autorisé : permissions insuffisantes ou clé API manquante
Déployer le logiciel de protection
Si votre logiciel d’automatisation a accès à l’appareil à protéger, le moyen le plus rapide d’installer le logiciel est de demander un programme d’installation avec jeton, qui installe et active le produit sans aucune interaction de l’utilisateur. Consultez également les paramètres disponibles de l’installateur pour des installations silencieuses.
Obtenir le lien de téléchargement du programme d’installation avec jeton
Exécutez cette commande GET :
Vous obtiendrez une réponse similaire à :
Le programme d’installation web (léger) par défaut est indiqué dans le champ downloadUrl
. Des téléchargements alternatifs pour des cas spécifiques sont également disponibles. Le jeton est unique pour votre groupe de politique par défaut dans votre espace de travail.
Important ! Ne partagez jamais vos jetons publiquement, car ils autorisent l’activation du logiciel avec votre clé de licence sans autre authentification ni activation manuelle.
Inviter un utilisateur par e-mail pour installer la protection
Exécutez cette commande POST :
Vous devriez recevoir un code HTTP 200 confirmant que le lien de téléchargement a bien été envoyé à l’utilisateur spécifié.
Conclusion
L’utilisation de l’API Emsisoft pour automatiser les tâches courantes est simple et ne nécessite pas une grande expérience en développement logiciel. Consultez la documentation complète de l’API pour découvrir d’autres fonctionnalités. Nous prévoyons également d’étendre considérablement les fonctionnalités disponibles dans les prochains mois.
Si vous avez des questions ou avez besoin d’aide, n’hésitez pas à contacter notre équipe d’assistance.