Pilz PITreader REST API Bedienungsanleitung Seite 2

Inhalt
1 Einführung
1.1 Gültigkeit der Dokumentation
1.2 Nutzung der Dokumentation
1.3 Zeichenerklärung
2 Bestimmungsgemäße Verwendung
3 Security ...................................................................................................................................
3.1 Implementierte
3.2 Erforderliche Security-Maßnahmen
4 Funktionsbeschreibung
4.1 Requests eines API-Clients
4.2 Überblick über Endpunkte für Requests
4.3 Response-Format
4.3.1 Response-Format bei HTTP-Status Code
4.3.2 Response-Format bei HTTP-Status Code
4.3.3 Response-Format bei HTTP-Status Code
4.3.4 Response-Format bei HTTP-Status Code
4.4 Kompatibilität nach einem Update der
4.5 Verbindungsaufbau/-abbau zwischen Client und Webserver
5 HTTP-Endpunkte des PITreaders
5.1 Allgemeine Geräteinformationen
5.1.1 HTTP-Endpunkt /api/status
5.1.2 HTTP-Endpunkt /api/config
5.1.3 HTTP-Endpunkt /api/config (POST)
5.1.4 HTTP-Endpunkt /api/config/coding (GET)
5.1.5 HTTP-Endpunkt /api/config/coding
5.1.6 HTTP-Endpunkt /api/config/blocklist (GET)
5.1.7 HTTP-Endpunkt /api/config/blocklist
5.1.8 HTTP-Endpunkt /api/config/devicegroups (GET)
5.1.9 HTTP-Endpunkt /api/config/devicegroups (POST)
5.2 Authentifizierungsstatus............................................................................................................
5.2.1 HTTP-Endpunkt /api/status/authentication (GET)
5.3 Daten des Transponders
5.3.1 HTTP-Endpunkt /api/transponder (GET)
5.3.2 HTTP-Endpunkt /api/transponder
5.3.3 HTTP-Endpunkt /api/transponder/teachIn (POST)
5.4 Anwenderdaten.........................................................................................................................
5.4.1 HTTP-Endpunkt /api/config/userData (GET)
5.4.2 HTTP-Endpunkt /api/config/userData/reset
5.4.3 HTTP-Endpunkt /api/config/userData/version (POST)
5.4.4 HTTP-Endpunkt /api/config/userData/parameter (POST)
5.4.5 HTTP-Endpunkt /api/transponder/userData
5.4.6 HTTP-Endpunkt /api/transponder/userData/read (POST)
5.4.7 HTTP-Endpunkt /api/transponder/userData/clear (POST)
5.4.8 HTTP-Endpunkt /api/transponder/userData/write
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
..............................................................................................................................
...................................................................................................
.....................................................................................................
......................................................................................................................
Security-Maßnahmen.......................................................................................
..........................................................................................
........................................................................................................
......................................................................................................
.....................................................................................................................
..............................................................................................
(GET)............................................................................................
(GET)............................................................................................
(POST)..............................................................................
..........................................................................................................
(POST)................................................................................
.....................................................................................
...................................................................................
200.........................................................................
400.........................................................................
403.........................................................................
500.........................................................................
PITreader-Firmware.....................................................
.........................................................................................
.........................................................................................
................................................................................
..............................................................................
(POST)............................................................................
.....................................................................
...................................................................
....................................................................
..................................................................................
...................................................................
............................................................................
(POST).................................................................
.............................................................
........................................................
(GET)...................................................................
........................................................
.......................................................
(POST)........................................................
...................................................
4
4
4
4
5
6
6
6
7
8
9
12
13
13
14
14
15
15
16
16
16
20
23
25
26
28
29
32
33
35
35
38
38
40
42
43
44
45
46
47
50
53
54
55
| 2