Fonctionnement d'API
Types d'appels API
Les types d'appels API GET, POST et DELETE sont disponibles dans l'API ESET PROTECT On-Prem.
•Les appels GET contiennent tout paramètre d'entrée (ils n'ont pas de corps) et envoient les données directement dans l'URL. L'appel de requête ne peut pas être modifié ; il peut être uniquement exécuté.
•Les appels POST requièrent un corps de requête : les paramètres sont documentés pour chaque appel POST.
•Dans les requêtes API qui incluent la pagination (page_size), la taille de page par défaut est de 100 et la taille maximale est de 10000.
Chaque appel se compose des éléments suivants :
•Type d'appel
•URL de requête
•En-tête de requête (peut être constitué du jeton d'authentification)
•Corps de la requête (contient des données, surtout avec les appels POST)
Structure de réponse du serveur
Chaque appel API reçoit une réponse du serveur REST. La réponse est constituée du code de réponse du serveur et la réponse est mise en forme sous forme de données en JSON.
La réponse se compose des éléments suivants :
•Code du serveur
•Corps de réponse
•En-têtes de réponse
Exemples d'appels API
GET
Afficher une politique (la Policy_UUID provient de la console Web) :
Méthode |
GET |
Fonction |
|
URL |
https://protect_server:9443/v2/policies/Policy_UUID |
Corps |
|
Autorisation |
Bearer token |
POST
Déplacer l'appareil vers un groupe statique spécifique (l'ID de l'ordinateur est inclus dans l'URL) :
Méthode |
POST |
Fonction |
|
URL |
https://protect_server:9443/v1/devices/a13f7d4c-e689-47cb-939d-91b9c9664a57:move |
Corps |
{ "newParentUuid": "be3d7451-e625-47fb-8f29-f98d61b40db1" } |
Autorisation |
Bearer token |