Register 5 · Blog · Blatt 41 · 2022-02
API v1: Bearer-Tokens und OpenAPI-Beschreibung
8. Februar 2022 · Merle Hartkopf
Seit heute gibt es die API v1. Sie arbeitet mit Bearer-Tokens, die Sie im Konto anlegen: bis zu 10 pro Konto. Ein Token zeigt Lunwerk nur einmal beim Anlegen an, gespeichert wird nur sein SHA-256-Hash. Wer ein Token verliert, legt ein neues an.
Ein erster Aufruf
GET /api/v1/reports/4711/verify
Authorization: Bearer <Ihr Token>
200 OK
{"id": 4711, "festgeschrieben": true, "kette_ok": true}Die Abfrage verify prüft die Prüfsummenkette der Baustelle bis zu diesem Bericht. Wer einen festgeschriebenen Bericht per API ändern will, bekommt 409 zurück.
Grenzen
- 60 Anfragen pro Minute und Token.
- Lesen und Schreiben für Tagesberichte, Zeiteinträge und Mängel.
- Die Beschreibung folgt OpenAPI 3.1 und steht mit allen Feldern auf /schnittstelle/.
Die bisherige Schnittstelle v0 gilt ab heute als veraltet. Einen Abschalttermin nennen wir rechtzeitig, und zwar mindestens ein halbes Jahr vorher. Änderungen am Produkt und an der Schnittstelle stehen unter /aenderungen/.