Γενικοί κανόνες

  • Το API REST είναι διαθέσιμο κάτω από τη βασική διεύθυνση URL:

/public/external/api

  • Όλα τα αιτήματα πρέπει να αποστέλλονται μέσω POST.
  • Το API REST υποστηρίζει μόνο αιτήσεις μέσω HTTPS.
  • Οι αιτήσεις πρέπει να περιέχουν τις ακόλουθες επικεφαλίδες:
Επεξεργασία

Όνομα κεφαλίδας



Τιμή κεφαλίδας



Περιγραφή



Τύπος περιεχομένου



application/json



σταθερό



auth



123…xyz



Κλειδί API από την καρτέλα “Πρόσβαση API”



υπογραφή



Υπογραφή κωδικοποιημένη σε Base64



Υπογραφή του ωφέλιμου φορτίου που παράγεται με το


private Key από την καρτέλα “API Access”


  • Το σώμα της αίτησης πρέπει να είναι ένα αντικείμενο κωδικοποιημένο σε json που πρέπει να περιέχει τις ακόλουθες τιμές:
Επεξεργασία

Πεδίο



Πεδίο Παράδειγμα Τιμή



Περιγραφή



api



v2/device/listdevices



Όνομα του API



χρόνος



1529662725



Χρονοσφραγίδα Unix (UTC) του υπολογιστή-πελάτη.


Η μέγιστη επιτρεπόμενη χρονική διαφορά


μεταξύ του πελάτη και του διακομιστή είναι 30


λεπτά.


  • Σε περίπτωση επιτυχίας, το API επιστρέφει τα ζητούμενα δεδομένα (βλ. Ερωτήματα παρακάτω) και έναν κωδικό κατάστασης HTTP 200.
  • Εάν προκύψει σφάλμα, ο κωδικός κατάστασης HTTP θα είναι μεταξύ 4xx και 5xx ανάλογα με το σφάλμα και το αντικείμενο απόκρισης θα περιέχει έναν πίνακα με το κλειδί “errors”, ο οποίος περιέχει μια λίστα με ευανάγνωστα από τον άνθρωπο μηνύματα σφάλματος.
  • Εάν δεν υπάρχουν αντίστοιχα δεδομένα για μια συσκευή, θα επιστραφεί ένας άδειος πίνακας.
  • Εάν ένα αναγνωριστικό συσκευής δεν υπάρχει, τα δεδομένα επιστροφής θα είναι null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.