Comment fonctionne API
Types d’appels API
Les types d’appel GET, POST et DELETE API sont disponibles dans ESET PROTECT On-Prem API.
•Les appels GET contiennent tous les paramètres 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 uniquement être exécuté.
•Les appels POST nécessitent un corps de demande : les paramètres sont documentés pour chaque appel POST.
•Dans les requêtes API qui incluent la pagination (page_size), la taille de la page par défaut est 100 et la taille maximale est 10000.
Chaque appel se compose des éléments suivants :
•Type d’appel
•URL de requête
•En-tête de requête (peut contenir le jeton d’authentification)
•Corps de la requête (contient les données, surtout pour les appels POST)
Structure de réponse serveur
Chaque appel API reçoit une réponse du serveur REST. La réponse contient le code de réponse du serveur et la réponse formatée en données dans JSON.
La réponse se compose des éléments suivants :
•Code serveur
•Corps de réponse
•En-têtes de réponse
Exemples d’appels API
GET
Afficher une politique (la Policy_UUID est tirée de la console Web) :
Méthode |
GET |
Fonction |
|
URL |
https://protect_server:9443/v2/policies/Policy_UUID |
Corps |
|
Autorisation |
Bearer token |
POST
Déplacez le périphérique vers un groupe statique spécifique (l’identifiant 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 |