Üldised eeskirjad

  • REST API on saadaval põhi-URL-i all:

/public/external/api

  • Kõik päringud tuleb saata POSTi teel.
  • REST API toetab päringuid ainult HTTPS-i kaudu.
  • Taotlused peavad sisaldama järgmisi päiseid:
Muuda

Pealkirja nimi



Pealkirja väärtus



Kirjeldus



Content-type



application/json



fikseeritud



auth



123…xyz



API võti vahekaardilt “API juurdepääs”



allkiri



Base64-kodeeritud allkiri



Allkiri kasuliku koormuse, mis on genereeritud


privaatne võti vahekaardilt “API juurdepääs”


  • Taotluse keha peab olema json-kodeeritud objekt, mis peab sisaldama järgmisi väärtusi:
Muuda

Väli



Välja näide Väärtus



Kirjeldus



api



v2/device/listdevices



API nimi



aeg



1529662725



Unixi ajatempel (UTC) kliendimasinas.


Maksimaalne lubatud ajaline erinevus


kliendi ja serveri vahel on 30


minutit.


  • Edukuse korral tagastab API taotletud andmed (vt allpool esitatud päringud) ja HTTP-koodi 200.
  • Kui esineb viga, on HTTP staatuskood sõltuvalt veast vahemikus 4xx ja 5xx ning vastusobjekt sisaldab massiivi võtmega “errors”, mis sisaldab inimloetavate veateadete nimekirja.
  • Kui seadme kohta ei ole sobivaid andmeid, tagastatakse tühi massiiv.
  • Kui seadme ID-d ei ole olemas, on selle tagastatav väärtus null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.