Werbung
Funktionsbeschreibung
4.4
Kompatibilität nach einem Update der PITreader-Firmware
Das Update einer PITreader-Firmware ist in Bezug auf die REST API abwärtskompatibel,
wenn sich bei der 3-stelligen Firmware-Version (z. B. 1.5.0) die Major-Firmware-Version (=
1. Stelle) nicht ändert.
Bei einem abwärtskompatiblen Firmware-Update kann ein Gerät mit alter Firmware-Version
(z. B. 1.5.0) durch ein Gerät mit neuer abwärtskompatibler Firmware (z. B. 1.6.0) ersetzt
werden, ohne Anpassungen bezüglich der REST API machen zu müssen.
Für eine abwärtskompatible PITreader-Firmware gilt:
}
Es sind alle Endpunkte der "alten" REST API verfügbar. Im Rahmen der Weiterentwick-
lung können jedoch weitere Endpunkte hinzukommen.
}
Es sind alle Parameter von GET-Requests und alle Felder von POST-Requests der "al-
ten" REST API verfügbar. Im Rahmen der Weiterentwicklung können jedoch weitere op-
tionale Parameter und Felder hinzukommen.
}
Auf einen Request des Clients sendet der Webserver eine Antwort (Response) im JSON-
Format. Die Antwort enthält alle Datenfelder der "alten" REST API. Im Rahmen der Wei-
terentwicklung können jedoch weitere Felder hinzukommen.
4.5
Verbindungsaufbau/-abbau zwischen Client und Webserver
Der Client (z. B. HMI, Web-Anwendung, Benutzer-Software) verbindet sich mit dem
Webserver des PITreaders, indem er einen HTTP-Request an die URL des Webservers
sendet. Nach einem fehlerfreien Request wird die Verbindung wieder abgebaut.
Verbindungen mit dem Webserver sind ausschließlich über HTTPS (Standard-Port 443)
möglich. Wenn eine Verbindung über HTTP (Standard-Port 80) mit dem Webserver aufge-
baut wird, erfolgt eine Weiterleitung auf HTTPS über den HTTP-Status 301 "Moved Per-
manently".
Request
}
Schematische Darstellung
GET https://<IP-Adresse>:<Port-Nummer>/api/<Endpunkt>
}
Parameter
<IP-Adresse>
<Port-Nummer>
<Endpunkt>
}
Beispiel
GET https://192.168.0.12:443/api/status
Response
}
Die Antwort ist abhängig vom Request.
}
Für das angegebene Beispiel siehe
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
IP-Adresse des Webservers
Default-IP-Adresse: 192.168.0.12
Standard-Port bei HTTPS: 443
Gewünschter Endpunkt in Abhängigkeit von der HTTP-
Methode (GET/POST)
HTTP-Endpunkt /api/status (GET) [
16].
| 15
Werbung
