Yleiset säännöt

  • REST API on saatavilla perus URL-osoitteen alapuolella:

/public/external/api

  • Kaikki pyynnöt on lähetettävä POST-palveluna.
  • REST API tukee vain HTTPS-pyyntöjä.
  • Pyyntöjen on sisällettävä seuraavat otsikot:
Muokkaa

Otsikon nimi



Otsikon arvo



Kuvaus



Content-type



application/json



kiinteä



auth



123…xyz



API-avain ”API Access” -välilehdeltä



allekirjoitus



Base64-koodattu allekirjoitus



Palkkion allekirjoitus, joka on luotu


yksityinen avain ”API Access” -välilehdeltä


  • Pyynnön rungon on oltava json-koodattu objekti, jonka on sisällettävä seuraavat arvot:
Muokkaa

Kenttä



Kenttä Esimerkki Arvo



Kuvaus



api



v2/device/listdevices



API:n nimi



aika



1529662725



Asiakaskoneen Unix-aikaleima (UTC).


Suurin sallittu aikaero


asiakkaan ja palvelimen välillä on 30


minuuttia.


  • Onnistuessaan API palauttaa pyydetyt tiedot (katso kyselyt alla) ja HTTP-tilakoodin 200.
  • Jos virhe tapahtuu, HTTP-tilakoodi on 4xx ja 5xx virheen mukaan, ja vastausobjekti sisältää sarjan, jonka avain on ”errors” ja joka sisältää luettelon ihmiselle luettavissa olevista virheilmoituksista.
  • Jos laitteelle ei löydy vastaavia tietoja, palautetaan tyhjä array.
  • Jos laitteen tunnusta ei ole olemassa, sen palautustiedot ovat nolla.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.