# Infos zu Web-API

Web API ist ein Rahmensystem für HTTP-Service, der für viele Clients einschließlich Browser und mobile Geräte angeboten wird.

### Basis-URL

Das ist die Basis-URL:

<Protokoll>://<Domainname>:<Portnummer>/api/v1

- Protokoll: HTTP (Version 1.1)
- Domainname: Verwendet die IP-Adresse des Anzeigegeräts.

  Hinweis: Wenn Sie Anzeigegeräte mit der Open Box der SP5000-Serie (Modell für Windows 10 IoT Enterprise), IPC-Serie oder PC/AT nutzen, können Sie den Gerätenamen ebenso verwenden.

- Portnummer: Die Portnummer kann in der Bildschirmbearbeitungs-Software eingerichtet werden. Konfigurieren der Web-Server-Servereinstellungen

## Anmeldung

Geben Sie den Benutzernamen und das Passwort ein, um den Token zu erhalten. Der Token für die Autorisierung beim Nutzen der "Sicherheit" erforderlich.

Hinweis: Token-basierte Identifizierung ist ein Sicherheitsverfahren zur Autorisierung von Benutzern, die sich durch von Servern bereitgestellte Sicherheits-Token an einem Server, Netzwerk oder anderen Sicherheitssystemen anmelden können.

Übersicht

### Anfrage

Element | Wert
Vorgehensweise | POST
URL | <Base URL>/login
Parameter | N/A
Kopfzeile | Inhaltstyp, Inhaltslänge
Kopfzeile | Wert
Content-Type | application/json
Body | JSON
Feld | Datentyp | Anmerkungen
username | Zeichenfolge | Benutzername
password | Zeichenfolge | Passwort
Beispiel | POST http://192.168.1.100:8000/api/v1/login HTTP/1.1 Host: localhost:8082 Content-Type: application/json content-length: 44 { "username":"User1", "password":"Pass1" } Hinweis: Der Beispiel-Code wurde in Java geschrieben.

### Antwort

Element | Wert
Zustands-Code | Bei erfolgreicher Authentifizierung sendet das Anzeigegerät 200 (OK).
Code | Hinweise
200 OK | Erfolgreiche Authentifizierung
401 Unauthorized | Keine Authentifizierung möglich
Kopfzeile | Inhaltstyp, Übertragungs-Kodierung
Kopfzeile | Wert
Content-Type | application/json
Transfer-Encoding | Chunked
Body | JSON
Feld | Datentyp | Hinweise
token | Zeichenfolge | Authentifizierter Token
Beispiel | 0 Hinweis: Der Beispiel-Code wurde in Java geschrieben.