summaryrefslogblamecommitdiffstats
path: root/documentation/de/api/README.md
blob: 4d3b4d4cbcb4f2feebe04684bcf15e468a0abcb2 (plain) (tree)
1
2
3
4
5
6
7
8
9








                                                                                                    
                                                                                          






                                                          
                                                                                             











                                                                                                                                                
                                                                                                     
 
                                                                                                                                                         






                                                    
                                                    
                                                     
                                                                                    
                                                  
                                              
                                                  
                                                
                                                              
                                          
                                                        
                                          

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": ""
}