Algemene regels

  • De REST API is beschikbaar onder de basis URL:

/public/external/api

  • Alle verzoeken moeten via POST worden verzonden.
  • De REST API ondersteunt alleen verzoeken via HTTPS.
  • Verzoeken moeten de volgende Headers bevatten:
Bewerk

Naam koptekst



Koptekst Waarde



Beschrijving



Inhoudstype



toepassing/json



vaste



auth



123…xyz



API-sleutel van het tabblad “API-toegang



handtekening



Base64-gecodeerde handtekening



Handtekening van de payload gegenereerd met de


privésleutel van het tabblad “API-toegang


  • De verzoektekst moet een json-gecodeerd object zijn dat de volgende waarden moet bevatten:
Bewerk

Veld



Veld Voorbeeld Waarde



Beschrijving



api



v2/device/listdevices



Naam van de API



tijd



1529662725



Unix Timestamp (UTC) van de clientcomputer.


Het maximaal toegestane tijdsverschil


tussen de client en de server is 30


minuten.


  • Bij succes retourneert de API de aangevraagde gegevens (zie de Queries hieronder) en een HTTP-statuscode 200.
  • Als er een fout optreedt, zal de HTTP-statuscode tussen 4xx en 5xx zijn, afhankelijk van de fout, en het antwoordobject zal een array bevatten met de sleutel “errors”, die een lijst met menselijk leesbare foutmeldingen bevat.
  • Als er geen overeenkomende gegevens zijn voor een apparaat, wordt een lege matrix geretourneerd.
  • Als een apparaat-id niet bestaat, zijn de retourgegevens nul.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.