Allmänna regler

  • REST API finns tillgängligt under bas-URL:en:

/public/external/api

  • Alla förfrågningar måste skickas via POST.
  • REST API stöder endast förfrågningar via HTTPS.
  • Förfrågningar måste innehålla följande rubriker:
Redigera

Rubrikens namn



Värde för rubrik



Beskrivning



Innehållstyp



applikation/json



fast



autentisering



123…xyz



API-nyckel från fliken ”API-åtkomst”



Underskrift



Base64-kodad signatur



Signatur för den nyttolast som genereras med


privat nyckel från fliken ”API-åtkomst”


  • Förfrågningsunderlaget måste vara ett json-kodat objekt som innehåller följande värden:
Redigera

Fält



Fält Exempel Värde



Beskrivning



Api



v2/enhet/listaenheter



Namn på API:et



tid



1529662725



Unix-tidsstämpel (UTC) för klientmaskinen.


Den maximalt tillåtna tidsskillnaden


mellan klienten och servern är 30


minuter.


  • Om API:et lyckas returnerar det de begärda uppgifterna (se Frågor nedan) och en HTTP-statuskod 200.
  • Om ett fel inträffar kommer HTTP-statuskoden att vara mellan 4xx och 5xx beroende på felet och svarsobjektet kommer att innehålla en array med nyckeln ”errors”, som innehåller en lista över felmeddelanden som kan läsas av människor.
  • Om det inte finns några matchande data för en enhet returneras en tom array.
  • Om ett enhets-ID inte finns kommer returdata att vara null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.