summaryrefslogtreecommitdiffstats
path: root/documentation/de/api/README.md
blob: 656172a8becc31071cf1a89532dfa0a171adaded (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

Erste Schritte

Die API kann unter folgender Adresse aufgerufen werden:

https://<domain_bss>/api/

Die Sammlungen und Ressourcen werden im Abschnitt Sammlungen beschrieben.

Autorisierung

Einige Sammlungen benötigen eine Authentifizierung, während andere ohne aufgerufen werden können. Um eine Anfrage zu authentifizieren, müssen Sie den Json-Web-Token an das Backend senden. Es gibt zwei Möglichkeiten, dies zu tun * Authorization Header\ Durch setzen des Bearer token im Authorization header.

Authorization: Bearer <jsonwebtoken>

\<jsonwebtoken> - Vollständiger json web token in der Form: header.payload.signature.

  • Cookies\ Um zu verhindern, dass der Javascript-Code der Website Zugriff auf den vollständige Jwt hat, wird der Token in zwei separate Cookies aufgeteilt
  • jwt_hp - Normaler Cookie mit dem Header und Payload des Jwt als Wert.
  • jwt_s - HTTP-only Cookie mit der Signature als Wert.

Um den Token zu erhalten, verwenden Sie die Anmeldemethode aus der API/Authentifizierung.

Rückgabewerte

Die API gibt Daten immer im JSON-Format zurück. Wenn die Anforderung erfolgreich war, wird der Statuscode 200 und die angeforderten Daten zurückgegeben. * 200 - OK\ Die Anfrage war erfolgreich. Optional enthält die Antwort ein Json-Objekt mit den enthaltenen Daten.

Wenn eine Anforderung nicht erfolgreich ist, setzt sie einen HTML-Statuscode und gibt ein Json-Objekt mit einem Status und einer Fehlernachricht zurück.

{
    "error": "",
    "message": ""
}