Herunterladen Inhalt Inhalt
Teilen
Diese Seite drucken
Pilz PITreader REST API Bedienungsanleitung
  1. Anleitungen
  2. Marken
  3. Pilz Anleitungen
  4. Regelkreise
  5. PITreader REST API
  6. Bedienungsanleitung
Pilz PITreader REST API Bedienungsanleitung

Pilz PITreader REST API Bedienungsanleitung

Vorschau ausblenden
Inhaltsverzeichnis

Werbung

Quicklinks

Diese Anleitung herunterladen
PITreader REST API
PITreader Firmware V1.5.x
}
Befehls- und Meldegeräte
Bedienungsanleitung-1005365-DE-05

Werbung

Inhaltsverzeichnis
loading

Verwandte Anleitungen für Pilz PITreader REST API

Inhaltszusammenfassung für Pilz PITreader REST API

  • Seite 1 PITreader REST API PITreader Firmware V1.5.x Befehls- und Meldegeräte Bedienungsanleitung-1005365-DE-05...

  • Seite 2: Inhaltsverzeichnis

    5.4.2 HTTP-Endpunkt /api/config/userData/reset (POST)..............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 (GET)..............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 (POST)............Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x 1005365-DE-05...
  • Seite 3 5.5.3 HTTP-Endpunkt /api/led (POST) ....................Authentifizierungstyp "Einzelauthentifizierung"................. 5.6.1 HTTP-Endpunkt /api/status/authentication/singleAuth (GET)........... Informationen zum aktuellen Benutzer ..................5.7.1 HTTP-Endpunkt /api/me (GET) ....................Applikationshinweise ......................Übersicht der Berechtigungen ..................... HTTP-Status Codes ....................... Zeitzonen ..........................Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x 1005365-DE-05...

  • Seite 4: Einführung

    Situationen, durch die das Produkt oder Geräte in dessen Umge- bung beschädigt werden können, und gibt entsprechende Vorsichtsmaß- nahmen an. Der Hinweis kennzeichnet außerdem besonders wichtige Text- stellen. INFO liefert Anwendungstipps und informiert über Besonderheiten. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x 1005365-DE-05...

  • Seite 5: Bestimmungsgemäße Verwendung

    Bestimmungsgemäße Verwendung Bestimmungsgemäße Verwendung PITreader REST API ist Bestandteil des PITreaders. Die REST API dient zum Zugriff auf HTTP-Endpunkte des geräteinternen Webservers über eine vom Benutzer erstellte Anwen- dung (externer Client). Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x 1005365-DE-05...

  • Seite 6: Security

    Industrial Security-Konzept zu implementieren (und kontinuierlich aufrechtzuerhalten), das dem aktuellen Stand der Technik entspricht. Führen Sie eine Risikoanalyse gemäß VDI/VDE 2182 oder IEC 62443-3-2 durch und pla- nen Sie die Security-Maßnahmen sorgfältig. Lassen Sie sich ggf. durch den Pilz Customer Support beraten. Implementierte Security-Maßnahmen Die Verbindung eines externen Clients mit dem Webserver ist ausschließlich über HTTPS...

  • Seite 7: Funktionsbeschreibung

    Responses im JSON-Format an den externen Client. PITreader HTTP Methodes: - GET - POST Client Webserver Request e.g.: - HMI HTTP - Web application Endpoints - User software Response Abb.: Informations- und Datenaustausch über die REST API (Prinzip) Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x 1005365-DE-05...

  • Seite 8: Requests Eines Api-Clients

    Request über HTTP-Methode GET oder POST oder POST https://<IP-Adresse><Port-Nummer><Endpunkt> Authorization Header <Type><ApiToken> Type immer: Bearer ApiToken Über die Web-Anwendung erzeugter API-Token (Kennwort) für den API- Client Beispiel: Authorization: Bearer <16 Byte-Wert> <…> <…> Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x 1005365-DE-05...

  • Seite 9: Überblick Über Endpunkte Für Requests

    (POST) [ /api/config/devicegroups Namen der Gerätegruppen anzeigen, denen das Gerät zugeordnet wurde siehe HTTP-Endpunkt /api/config/devicegroups (GET) [ POST Name für eine Gerätegruppe eingeben oder Name einer Gerätegruppe ändern siehe HTTP-Endpunkt /api/config/devicegroups (POST) [ Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x 1005365-DE-05...
  • Seite 10 Daten für eine einzelne Gerätegruppe im Arbeitsspei- clearGroup cher eines PITreaders löschen siehe HTTP-Endpunkt /api/transponder/userData/clear- Group (POST) [ /api/transponder/userData/ POST Daten einer Gerätegruppe im Arbeitsspeicher des addGroupValues PITreader hinzufügen siehe HTTP-Endpunkt /api/transponder/userData/add- GroupValues (POST) [ Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 10 1005365-DE-05...
  • Seite 11 HTTP-Endpunkt /api/led (POST) [ /api/status/authentication/ Einzelauthentifizierung: Status der Authentifizierungs- singleAuth sperre auslesen siehe HTTP-Endpunkt /api/status/authentication/ singleAuth (GET) [ /api/me Informationen zum aktuellen Benutzer auslesen siehe HTTP-Endpunkt /api/me (GET) [ Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 11 1005365-DE-05...

  • Seite 12: Response-Format

    Response-Format bei HTTP-Status Code 200 [ Fehlerhafter Request: siehe Response-Format bei HTTP-Status Code 400 [ Unerlaubter Request: siehe Response-Format bei HTTP-Status Code 403 [ Interner Fehler: siehe Response-Format bei HTTP-Status Code 500 [ Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 12 1005365-DE-05...

  • Seite 13: Response-Format Bei Http-Status Code 200

    Response-Header. Inhalte des Response-Headers HTTP-Status Code 400 Content Type: application/json <weitere> Generische Datenfelder im Body Feldname Datentyp Inhalt STRING "" (leerer String) data OBJECT null success BOOLEAN false Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 13 1005365-DE-05...

  • Seite 14: Response-Format Bei Http-Status Code 403

    Bei einem internen Fehler antwortet der Webserver mit HTTP-Status Code 500 (Internal server error). Inhalte des Response-Headers HTTP-Status Code 500 Content Type: application/json <weitere> Generische Datenfelder im Body Feldname Datentyp Inhalt STRING "" (leerer String) data OBJECT null success BOOLEAN false Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 14 1005365-DE-05...

  • Seite 15: Kompatibilität Nach Einem Update Der Pitreader-Firmware

    <Endpunkt> Gewünschter Endpunkt in Abhängigkeit von der HTTP- Methode (GET/POST) Beispiel GET https://192.168.0.12:443/api/status Response Die Antwort ist abhängig vom Request. Für das angegebene Beispiel siehe HTTP-Endpunkt /api/status (GET) [ 16]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 15 1005365-DE-05...

  • Seite 16: Http-Endpunkte Des Pitreaders

    Status der Verbindung zwischen PIT m4SEU und PITreader Möglicher Inhalt: true Es besteht eine aktive Verbindung zwischen einem PIT m4SEU und dem PITreader. false Es besteht keine Verbindung zwi- schen einem PIT m4SEU und dem PITreader. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 16 1005365-DE-05...
  • Seite 17 Konfiguration des 24 V-I/O-Ports Möglicher Inhalt: input Der 24 V-I/O-Port ist als Eingang konfiguriert. output Der 24 V-I/O-Port ist als Ausgang konfiguriert. ioPortValue NUMBER Signal, das am 24 V-I/O-Port anliegt Möglicher Inhalt: Low-Signal High-Signal Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 17 1005365-DE-05...
  • Seite 18 Es ist keine Codierungskennung ge- speichert. transponderAuthenticated BOOLEAN Authentifizierungsstatus des Transponders Möglicher Inhalt: true Der Transponder wurde authentifi- ziert. false Der Transponder wurde nicht au- thentifiziert. hwVariant NUMBER Hardware-Variante des PITreaders Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 18 1005365-DE-05...
  • Seite 19 Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 19 1005365-DE-05...

  • Seite 20: Http-Endpunkt /Api/Config (Get)

    HTTP-Port ist auf dem Gerät nicht aktiviert httpsPort NUMBER HTTPS-Port-Nummer Default-Nummer: 443 sntpEnabled BOOLEAN SNTP-Status Möglicher Inhalt: true SNTP ist auf dem Gerät aktiviert false SNTP ist auf dem Gerät nicht akti- viert Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 20 1005365-DE-05...
  • Seite 21 Gibt an, ob Startdatum ("Gültig ab") und Enddatum ("Gültig bis") vom Transponder ausgewertet werden. Möglicher Inhalt: true Auswertung aktiviert false Auswertung nicht aktiviert timeZone STRING Name der Zeitzone Möglicher Inhalt siehe Zeitzonen [ Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 21 1005365-DE-05...
  • Seite 22 Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 22 1005365-DE-05...

  • Seite 23: Http-Endpunkt /Api/Config (Post)

    String nach RFC3339 section-5.6, Datum und Zeit in UTC min. 01.01.2000 00:00 UTC Format: 2018-06-28T00:00:00Z Hinweis: Alle übergebenen Parameter müssen gültig sein und es muss mindestens ein Para- meter übergeben werden. Beispiel POST https://192.168.0.12/api/config Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 23 1005365-DE-05...
  • Seite 24 Datenfeld "msg" genauere Angaben zur Fehlerursache enthalten. Mögliche Inhalte des generischen Datenfelds "msg" Fehlerursache: fehlerhafte Parameter Inhalt im generischen Datenfeld "msg": – API.errorLocation – API.errorDeviceGroup – API.errorEvaluateTimeLimitation – API.errorTimeZone – API.errorRealTimeClock Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 24 1005365-DE-05...

  • Seite 25: Http-Endpunkt /Api/Config/Coding (Get)

    Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 25 1005365-DE-05...

  • Seite 26: Http-Endpunkt /Api/Config/Coding (Post)

    Bei einem Request mit POST besteht der Response-Body ausschließlich aus den generi- schen Datenfeldern. Response bei HTTP-Status Code 200 Sie finden Informationen zu den generischen Datenfeldern bei einem fehlerfreien Request unter Response-Format bei HTTP-Status Code 200 [ 13]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 26 1005365-DE-05...
  • Seite 27 Response bei einem fehlerhaften oder unerlaubten Request INFO Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 27 1005365-DE-05...

  • Seite 28: Http-Endpunkt /Api/Config/Blocklist (Get)

    Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 28 1005365-DE-05...

  • Seite 29: Http-Endpunkt /Api/Config/Blocklist (Post)

    Die Eingabe von UTF8-Zeichen, die mehr als 1 Byte benötigen, verringert die maximal erlaubte Zeichenanzahl von 32 Zeichen. Hinweis: Die Parameter "action", id", "data" und "comment" müssen immer übergeben werden. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 29 1005365-DE-05...
  • Seite 30 Abweichend vom dokumentierten Inhalt unter Response-Format bei HTTP-Status Code 400 [ kann das generische Datenfeld "msg" genauere Angaben zur Fehlerursache enthalten. Mögliche Inhalte des generischen Datenfelds "msg": Fehlerursache: nicht erlaubte Aktion oder ungültiger Parameter Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 30 1005365-DE-05...
  • Seite 31 Inhalt im generischen Datenfeld "msg": – API.errorMaximumSize: Die Blockierliste enthält bereits die maximal zulässige Anzahl an Einträgen. – API.errorDuplicateSecurityId: Die Security-ID ist in der Blockierliste bereits enthalten. – API.errorInvalidSecurityId: Die Security-ID ist ungültig. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 31 1005365-DE-05...

  • Seite 32: Http-Endpunkt /Api/Config/Devicegroups (Get)

    Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 32 1005365-DE-05...

  • Seite 33: Http-Endpunkt /Api/Config/Devicegroups (Post)

    Bei einem Request mit POST besteht der Response-Body ausschließlich aus den generi- schen Datenfeldern. Response bei HTTP-Status Code 200 Sie finden Informationen zu den generischen Datenfeldern bei einem fehlerfreien Request unter Response-Format bei HTTP-Status Code 200 [ 13]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 33 1005365-DE-05...
  • Seite 34 Mögliche Inhalte des generischen Datenfelds "msg": Fehlerursache: ungültiger Parameter Inhalt im generischen Datenfeld "msg": – "" (leerer String): keine Daten empfangen – API.errorDevicegroupFormat: fehlerhafter Inhalt in "name" – API.errorInvalidDevicegroupIndex: ungültiger Wert in "number" Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 34 1005365-DE-05...

  • Seite 35: Authentifizierungsstatus

    Der Transponder wurde authentifi- ziert. false Der Transponder wurde nicht au- thentifiziert. permission NUMBER authentifizierte Berechtigung authenticationStatus NUMBER Status des Authentifizierungsvorgangs Möglicher Inhalt: kein Transponder Vorgang abgeschlossen warten auf externe Authentifizierung Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 35 1005365-DE-05...
  • Seite 36 (Typ-ID 10 … 15 oder 30). stringValue STRING Zeichenwerte des Parameters (optional) Hinweis: Das Datenfeld ist nur vorhanden, wenn es sich um einen Parameter mit Typ-ID 1 (STRING) oder Typ-ID 20 (DATETIME) han- delt. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 36 1005365-DE-05...
  • Seite 37 Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 37 1005365-DE-05...

  • Seite 38: Daten Des Transponders

    Parameters "teachInId" übereinstimmen (sie- he Parameter "teachInID <UID>" unter HTTP-Endpunkt /api/transponder/teachIn (POST) [ 42]). securityId STRING Security-ID des Transponders permissions ARRAY of Berechtigung für die Gerätegruppe NUMBER (Gerätegruppen 0 … 31, Hamming-codiert) Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 38 1005365-DE-05...
  • Seite 39 Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 39 1005365-DE-05...

  • Seite 40: Http-Endpunkt /Api/Transponder (Post)

    Die Beschränkung wird aktiviert. Hinweis: Startdatum, Enddatum und Beschränkung können mit den Parametern "ti- meLimitationStart", "timeLimitationEnd" und "codingLock" unabhängig von "locked- Permissions" gesetzt werden (siehe HTTP-Endpunkt /api/transponder (GET) [ 38]). Beispiel Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 40 1005365-DE-05...
  • Seite 41 Response bei einem fehlerhaften oder unerlaubten Request INFO Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 41 1005365-DE-05...

  • Seite 42: Http-Endpunkt /Api/Transponder/Teachin (Post)

    Response bei einem fehlerhaften oder unerlaubten Request INFO Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 42 1005365-DE-05...

  • Seite 43: Anwenderdaten

    (Parameterdefinition) POST /api/transponder/userData/clear GET /api/transponder/userData Arbeitsspeicher POST /api/transponder/userData/clearGroup (Kopie der Daten des Transponders) POST /api/transponder/userData/addGroupValues REST-API POST /api/transponder/userData/write POST /api/transponder/userData/read Transponder Abb.: Wirkungsweise von Requests an die HTTP-Endpunkte für Anwenderdaten Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 43 1005365-DE-05...

  • Seite 44: Http-Endpunkt /Api/Config/Userdata (Get)

    Typ-ID (= ID des Datentyps) size NUMBER Maximale Zeichenanzahl für einen Parameter des Datentyps "STRING" (optional) Hinweis: Das Datenfeld ist ausschließlich bei einem Parameter mit Typ-ID 1 (STRING) vor- handen. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 44 1005365-DE-05...

  • Seite 45: Http-Endpunkt /Api/Config/Userdata/Reset (Post)

    Response bei einem fehlerhaften oder unerlaubten Request INFO Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 45 1005365-DE-05...

  • Seite 46: Http-Endpunkt /Api/Config/Userdata/Version (Post)

    Response bei einem fehlerhaften oder unerlaubten Request INFO Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 46 1005365-DE-05...

  • Seite 47: Http-Endpunkt /Api/Config/Userdata/Parameter (Post)

    Ist die übergebene Parameter-ID in der Anwenderdaten-Konfiguration noch nicht vorhanden, so wird der Parameter in der Anwenderdaten-Konfiguration neu ange- legt. Ist die übergebene Parameter-ID bereits in der Anwenderdaten-Konfiguration vor- handen, so wird der Parameter entsprechend aktualisiert. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 47 1005365-DE-05...
  • Seite 48 Bei einem Request mit POST besteht der Response-Body ausschließlich aus den generi- schen Datenfeldern. Response bei HTTP-Status Code 200 Sie finden Informationen zu den generischen Datenfeldern bei einem fehlerfreien Request unter Response-Format bei HTTP-Status Code 200 [ 13]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 48 1005365-DE-05...
  • Seite 49 Fehlerursache: Es wurde eine reservierte Parameter-ID mit falscher Typ-ID oder falscher Angabe im Datenfeld "size" verwendet. Inhalt im generischen Datenfeld "msg": – API.errorPredefinedId Unspezifische Fehlerursachen Inhalt im generischen Datenfeld "msg": – "" (leerer String) Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 49 1005365-DE-05...

  • Seite 50: Http-Endpunkt /Api/Transponder/Userdata (Get)

    Hinweis: Das Datenfeld ist ausschließlich bei einem Parame- ter mit Typ-ID 1 (STRING) vorhanden. Mögliche Datenlänge siehe [*1] groups ARRAY of Nach Gerätegruppe gruppierte Parameterdaten, die auf dem OBJECT Transponder abgelegt sind Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 50 1005365-DE-05...
  • Seite 51 INT16S 2 Byte -32768 ... 32767 INT32U 4 Byte 0 ... 4294967295 INT32S 4 Byte -2147483648 ... 2147483647 DATETIME 4 Byte leere Zeit/Datum PERMISSION 4 Byte 0 ... 64 (Hamming-codiert) Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 51 1005365-DE-05...
  • Seite 52 Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 52 1005365-DE-05...

  • Seite 53: Http-Endpunkt /Api/Transponder/Userdata/Read (Post)

    Fehlerursache: Daten konnten nicht vom Transponder gelesen werden – keine Daten auf dem Transponder vorhanden oder – die Daten auf dem Transponder sind ungültig Abhilfe: Verwenden Sie den Clear-Endpunkt (siehe HTTP-Endpunkt /api/transponder/userData/ clear (POST) [ 54]). Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 53 1005365-DE-05...

  • Seite 54: Http-Endpunkt /Api/Transponder/Userdata/Clear (Post)

    HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Response bei einem fehlerhaften Request mit HTTP-Status Code 400 Inhalt des generischen Datenfelds "msg": "" (leerer String) Fehlerursache: Transponder ist nicht platziert Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 54 1005365-DE-05...

  • Seite 55: Http-Endpunkt /Api/Transponder/Userdata/Write (Post)

    Inhalt des generischen Datenfelds "msg": "" (leerer String) Fehlerursache: Transponder ist nicht platziert oder Fehlerursache: Anwenderdaten auf dem PITreader wurden zuvor weder zurückgesetzt noch vom Transponder auf den PITreader geladen Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 55 1005365-DE-05...
  • Seite 56 Response bei einem fehlerhaften Request mit HTTP-Status Code 500 Inhalt des generischen Datenfelds "msg": "" (leerer String) Fehlerursache: Fehler beim Schreiben der Anwenderdaten auf dem Transponder. Die an- gelegten Anwenderdaten übersteigen die Speicherkapazität des Transponders. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 56 1005365-DE-05...

  • Seite 57: Http-Endpunkt /Api/Transponder/Userdata/Cleargroup (Post)

    Abweichend vom dokumentierten Inhalt unter Response-Format bei HTTP-Status Code 400 [ kann das generische Datenfeld "msg" genauere Angaben zur Fehlerursache enthalten. Mögliche Inhalte des generischen Datenfelds "msg": Fehlerursache: fehlerhafte Parameter Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 57 1005365-DE-05...
  • Seite 58 HTTP-Endpunkte des PITreaders Inhalt im generischen Datenfeld "msg": – API.errorInvalidDevicegroupIndex: Der Wert für "deviceGroup" ist ungültig. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 58 1005365-DE-05...

  • Seite 59: Http-Endpunkt /Api/Transponder/Userdata/Addgroupvalues (Post)

    Wert übergeben werden (Typ-ID 10 … 15 oder 30). stringValue <Wert> Zeichenwerte des Parameters (optional) Wert: gültige Eingabe in Abhängigkeit von "type": Typ-ID 1 gültiger UTF-8 String (max. Zeichenanzahl = "size") Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 59 1005365-DE-05...
  • Seite 60 POST https://192.168.0.12/api/transponder/userData/addGroupValues "deviceGroup": 105, "values": { "id": 10001, "type": 1, "size": 40, "stringValue": "James Pilz" } [*1] Hinweis: Die Größe von JSON-Daten im Body von Requests mit POST darf 1100 Byte nicht überschreiten. Anfragen mit einer größeren Datenlänge müssen auf mehrere Re- quests aufgeteilt werden.
  • Seite 61 "type" stimmt nicht mit der Parameterdefinition überein (fehlende Datenfelder). – API.errorInvalidGroupValue: - Der Wert für "numericValue" ist ungültig oder - Der String für "stringValue" ist ungültig. Die maximale Zeichenanzahl von "size" weicht von der Parameterdefinition ab. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 61 1005365-DE-05...

  • Seite 62: Externe Authentifizierung

    Response bei einem fehlerhaften oder unerlaubten Request INFO Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 62 1005365-DE-05...
  • Seite 63 Mögliche Fehlerursachen: – Die übermittelte Security-ID stimmt nicht mit der Security-ID des aktuell anliegenden Transponders überein. – Es befindet sich kein Transponder im Lesebereich. Inhalt des generischen Datenfelds "msg": – API.errorInvalidSecurityId Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 63 1005365-DE-05...

  • Seite 64: Http-Endpunkt /Api/Led (Get)

    Die Antwort enthält im Body die folgenden Request-spezifischen Datenfelder und Inhalte im JSON-Format: Feldname Datentyp Bedeutung colour NUMBER aktuelle LED-Farbe Möglicher Inhalt: ausgeschaltet blau gelb grün flashMode NUMBER aktueller LED-Blinkmodus Möglicher Inhalt: statischer Leuchtmodus Blinkmodus (1Hz) overwrite: OBJECT - - - Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 64 1005365-DE-05...
  • Seite 65 Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 65 1005365-DE-05...

  • Seite 66: Http-Endpunkt /Api/Led (Post)

    POST https://192.168.0.12/api/led "colour": 2, "flashMode": 0, "activated": true Response Sie finden generelle Informationen unter Response-Format [ 12]. Bei einem Request mit POST besteht der Response-Body ausschließlich aus den generi- schen Datenfeldern. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 66 1005365-DE-05...
  • Seite 67 Response bei einem fehlerhaften oder unerlaubten Request INFO Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite- re Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 67 1005365-DE-05...

  • Seite 68: Authentifizierungstyp "Einzelauthentifizierung

    Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 68 1005365-DE-05...

  • Seite 69: Informationen Zum Aktuellen Benutzer

    Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re- sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent- hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie finden weitere Informationen unter Response-Format [ 12]. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 69 1005365-DE-05...

  • Seite 70: Applikationshinweise

    TLS Session Tickets Wir empfehlen einen REST-Client zu verwenden, der TLS Session Tickets unterstützt. Zyklischer Zugriff auf Daten Wir empfehlen maximal 2 Requests pro Sekunde an den Webserver des PITreaders zu senden. Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 70 1005365-DE-05...

  • Seite 71: Übersicht Der Berechtigungen

    0x000aab5a 699226 0x000b5299 742041 0x000b5366 742246 0x000b6c96 748694 0x000b6d69 748905 0x000cdeff 843519 0x000cdf00 843520 0x000ce0f0 844016 0x000ce10f 844047 0x000d18cc 858316 0x000d1933 858419 0x000d26c3 861891 0x000d273c 862012 0x00304c6a 3165290 0x00304d95 3165589 Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 71 1005365-DE-05...
  • Seite 72 0x003ae6cf 3860175 0x003ae730 3860272 0x003b1ef3 3874547 0x003b1f0c 3874572 0x003b20fc 3875068 0x003b2103 3875075 0x003c9295 3969685 0x003c936a 3969898 0x003cac9a 3976346 0x003cad65 3976549 0x003d54a6 4019366 0x003d5559 4019545 0x003d6aa9 4025001 0x003d6b56 4025174 0x00c04e98 12603032 Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 72 1005365-DE-05...

  • Seite 73: Http-Status Codes

    Die Antwort auf einen Request enthält im Response-Header immer einen HTTP-Status Co- de. Die folgende Liste enthält die möglichen HTTP-Status Codes: HTTP-Status Code Bedeutung Bad request Forbidden Internal server error Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 73 1005365-DE-05...

  • Seite 74: Zeitzonen

    Amerika/Buenos Aires (-3:00) Buenos Aires Amerika/Rio de Janeiro (-3:00) Rio de Janeiro Amerika/Sao Paulo (-3:00) Sao Paulo Europa/London (+0:00) London Afrika/Brazzaville (+1:00) Brazzaville Europa/Barcelona (+1:00) Barcelona Europa/Belgrad (+1:00) Belgrade Europa/Berlin (+1:00) Berlin Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 74 1005365-DE-05...
  • Seite 75 Asien/Hyderabad (+5:30) Hyderabad Asien/Kolkata (+5:30) Kolkata Asien/Mumbai (+5:30) Mumbai Asien/Pune (+5:30) Pune Asien/Surat (+5:30) Surat Asien/Katmandu (+5:45) Katmandu Asien/Rangun (+6:30) Rangoon Asien/Bangkok (+7:00) Bangkok Asien/Peking (+8:00) Beijing Asien/Changzhou (+8:00) Changzhou Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 75 1005365-DE-05...
  • Seite 76 Asien/Osaka (+9:00) Osaka Asien/Seoul (+9:00) Seoul Asien/Tokio (+9:00) Tokyo Australien/Adelaide (+9:30) Adelaide Australien/Darwin (+9:30) Darwin Australien/Brisbane (+10:00) Brisbane Australien/Hobart (+10:00) Hobart Australien/Sydney (+10:00) Sydney Pazifik/Guam (+10:00) Guam Pazifik/Auckland (+12:00) Auckland Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x | 76 1005365-DE-05...
  • Seite 77 Wir sind international vertreten. Nähere Informationen entnehmen Sie bitte unserer Homepage www.pilz.com oder nehmen Sie Kontakt mit unserem Stammhaus auf. Stammhaus: Pilz GmbH & Co. KG, Felix-Wankel-Straße 2, 73760 Ostfildern, Deutschland Telefon: +49 711 3409-0, Telefax: +49 711 3409-133, E-Mail: info@pilz.de, Internet: www.pilz.com...

Diese Anleitung auch für:

Pitreader firmware v1.5.x

Inhaltsverzeichnis