Règles générales

  • L’API REST est disponible sous l’URL de base :

/public/external/api

  • Toutes les demandes doivent être envoyées via POST.
  • L’API REST ne prend en charge que les requêtes via HTTPS.
  • Les demandes doivent contenir les en-têtes suivants :
Éditer

Nom de l’en-tête



Valeur de l’en-tête



Description



Type de contenu



application/json



fixe



authentification



123…xyz



Clé API à partir de l’onglet « Accès API



signature



Signature encodée en base64



Signature de la charge utile générée avec la fonction


clé privée dans l’onglet « Accès à l’API


  • Le corps de la demande doit être un objet encodé en json qui doit contenir les valeurs suivantes :
Éditer

Champ d’application



Champ Exemple Valeur



Description



api



v2/device/listdevices



Nom de l’API



temps



1529662725



Horodatage Unix (UTC) de la machine cliente.


Le décalage horaire maximum autorisé


entre le client et le serveur est de 30


minutes.


  • En cas de succès, l’API renvoie les données demandées (voir les requêtes ci-dessous) et un code d’état HTTP 200.
  • En cas d’erreur, le code d’état HTTP sera compris entre 4xx et 5xx en fonction de l’erreur et l’objet de réponse contiendra un tableau avec la clé « errors », qui contient une liste de messages d’erreur lisibles par l’homme.
  • S’il n’y a pas de données correspondantes pour un appareil, un tableau vide sera renvoyé.
  • Si l’identifiant d’un appareil n’existe pas, les données renvoyées seront nulles.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.