Generelle regler

  • REST-API’en er tilgængelig under basis-URL’en:

/public/external/api

  • Alle anmodninger skal sendes via POST.
  • REST API’en understøtter kun anmodninger via HTTPS.
  • Anmodninger skal indeholde følgende overskrifter:
Rediger

Overskriftsnavn



Overskriftsværdi



Beskrivelse



Indholdstype



applikation/json



fast



godkendelse



123…xyz



API-nøgle fra fanen “API-adgang”



underskrift



Base64-kodet signatur



Signatur af nyttelasten genereret med


privat nøgle fra fanen “API-adgang”


  • Anmodningskroppen skal være et json-kodet objekt, som skal indeholde følgende værdier:
Rediger

Felt



Felt Eksempel Værdi



Beskrivelse



api



v2/enhed/listeenheder



Navn på API’en



tid



1529662725



Unix-tidsstempel (UTC) for klientmaskinen.


Den maksimalt tilladte tidsforskel


mellem klienten og serveren er 30


minutter.


  • Hvis det lykkes, returnerer API’en de ønskede data (se forespørgslerne nedenfor) og en HTTP-statuskode 200.
  • Hvis der opstår en fejl, vil HTTP-statuskoden være mellem 4xx og 5xx afhængigt af fejlen, og svarobjektet vil indeholde et array med nøglen “errors”, som indeholder en liste over menneskeligt læsbare fejlmeddelelser.
  • Hvis der ikke er nogen matchende data for en enhed, returneres et tomt array.
  • Hvis en enheds-id ikke findes, vil dens returdata være null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.