Werbung
Funktionsbeschreibung
4.1
Requests eines API-Clients
Ein externer Client wird auch als API-Client bezeichnet. Bei einem API-Client handelt es
sich im weitesten Sinn um eine Maschine (z. B. PASvisu). Die Authentifizierung von Ma-
schinen am Webserver erfolgt über API-Tokens (API-Keys); d. h. der API-Token muss bei
einem Request des API-Clients angegeben werden. Die Generierung eines API-Tokens er-
folgt in der Web-Anwendung des PITreaders. In der Web-Anwendung können hierzu API-
Clients angelegt und konfiguriert werden.
Anlegen eines API-Clients
In der Web-Anwendung des PITreaders können unter Konfiguration -> API-Clients bis zu
3 API-Clients angelegt und konfiguriert werden. Die Web-Anwendung generiert automa-
tisch für jeden angelegten Client einen eigenen API-Token und zeigt ihn an. Der API-Token
ist ein Zufallswert mit einer Länge von 16 Byte und entspricht in seiner Funktionalität einem
Kennwort.
Request mit Authentifizierung über den API-Token
Bei jedem Zugriff muss im Request der Authorization Header mit dem zugehörigen API-To-
ken angegeben werden. Bei fehlendem oder ungültigem Authorization Header enthält die
Antwort den HTTP-Status-Code 403 (siehe
Prinzipieller Aufbau eines Requests mit Authorization Header
Request Header
<...>
GET https://<IP-Adresse><Port-Nummer><Endpunkt>
oder
POST https://<IP-Adresse><Port-Nummer><Endpunkt>
Authorization Header
<Type><ApiToken>
<...>
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
HTTP-Status Codes [
<...>
Request über HTTP-Methode GET oder POST
Type
immer: Bearer
ApiToken Über die Web-Anwendung erzeugter
API-Token (Kennwort) für den API-
Client
Beispiel:
Authorization: Bearer <16 Byte-Wert>
<...>
73]).
| 8
Werbung
