Általános szabályok

  • A REST API az alap URL alatt érhető el:

/public/external/api

  • Minden kérést POST-on keresztül kell elküldeni.
  • A REST API csak a HTTPS-en keresztül történő kéréseket támogatja.
  • A kéréseknek a következő fejléceket kell tartalmazniuk:
Szerkesztés

Fejléc neve



Fejléc értéke



Leírás



Content-type



application/json



rögzített



auth



123…xyz



API kulcs az „API hozzáférés” fülön



aláírás



Base64 kódolt aláírás



A payload aláírása, amelyet a


privát kulcs az „API hozzáférés” lapon


  • A kérés testének egy json kódolású objektumnak kell lennie, amelynek a következő értékeket kell tartalmaznia:
Szerkesztés

Terep



Mező Példa Érték



Leírás



api



v2/device/listdevices



Az API neve



idő



1529662725



Az ügyfélgép Unix időbélyege (UTC).


A maximálisan megengedett időkülönbség


az ügyfél és a kiszolgáló között 30


percek.


  • Siker esetén az API visszaküldi a kért adatokat (lásd az alábbi lekérdezéseket) és egy 200-as HTTP státuszkódot.
  • Hiba esetén a HTTP státuszkód a hibától függően 4xx és 5xx között lesz, és a válaszobjektum tartalmaz egy tömböt az „errors” kulcsával, amely az ember által olvasható hibaüzenetek listáját tartalmazza.
  • Ha nincs megfelelő adat egy eszközhöz, akkor egy üres tömb kerül visszaadásra.
  • Ha egy eszközazonosító nem létezik, a visszatérő adat nulla lesz.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.