Allgemeine Regeln

  • Die REST-API ist unterhalb der Basis-URL verfügbar:

/public/external/api

  • Alle Anfragen müssen per POST gesendet werden.
  • Die REST-API unterstützt nur Anfragen über HTTPS.
  • Die Anfragen müssen die folgenden Kopfzeilen enthalten:
bearbeiten

Kopfzeile Name



Kopfzeile Wert



Beschreibung



Inhaltstyp



anwendung/json



fest



auth



123…xyz



API-Schlüssel auf der Registerkarte „API-Zugang“.



Unterschrift



Base64 kodierte Signatur



Signatur der Nutzdaten, die mit dem


privaten Schlüssel auf der Registerkarte „API-Zugang


  • Der Request Body muss ein json kodiertes Objekt sein, das die folgenden Werte enthält:
bearbeiten

Feld



Feld Beispielwert



Beschreibung



api



v2/Gerät/ListeGeräte



Name der API



Zeit



1529662725



Unix-Zeitstempel (UTC) des Client-Rechners.


Die maximal zulässige Zeitdifferenz


zwischen dem Client und dem Server beträgt 30


Minuten.


  • Bei Erfolg gibt die API die angeforderten Daten (siehe die Abfragen unten) und einen HTTP-Statuscode 200 zurück.
  • Wenn ein Fehler auftritt, ist der HTTP-Statuscode je nach Fehler zwischen 4xx und 5xx und das Antwortobjekt enthält ein Array mit dem Schlüssel „errors“, das eine Liste von menschenlesbaren Fehlermeldungen enthält.
  • Wenn es keine passenden Daten für ein Gerät gibt, wird ein leeres Array zurückgegeben.
  • Wenn eine Geräte-ID nicht existiert, sind die Rückgabedaten Null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.