Release 2022.36
API Authentifizierung
Die OneGov Cloud API ermöglicht eine Authentifizierung für Nutzer, die auf das Rate Limit gestossen sind.
Die Komponente onegov.api wurde um einen Authentifizierungs-Flow erweitert.
Dieser erleichtert den Umgang für den maschinenlesbare Zugriff: für authentifizierte Nutzer ist nämlich das Rate Limit aufgehoben.
Die OneGov Cloud API setzt hierbei auf eine token-basierte Authentifizierung.
Die Authentisierung der Requests erfolgt mittels kurzlebigen Access-Tokens.
Auf der Website kann unter
Einstellungen/OneGov APIein neuer Schlüssel erstellt werden. Der Name des Schlüssels kann beliebig sein.In einen zweiten Schritt kann ein Token generiert werden. Dabei wird ein Request mit dem soeben erstellten Schlüssel abgesendet:
curl -u 659912a7-0fa6-4906-aebd-c7aeb813fcff: \
URL/api/authenticate
Die Nummer 659912a7-0fa6-4906-aebd-c7aeb813fcff ist der Applikations-Schlüssel, mit dem das Token gelöst wird.
Beispielhafte Response:
{
"token":"eyJhbGciOiJIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRhZmJiZGY1LZWNkNDUzZSIsImlhdCI6MTY5MjYzMjQ5MCwiZXhwIjoxNjkyNjM2MDkwfQ.9T5Sk2G9AK7JyUtEF5QU5pIyxnZDGzvJOcDwA_sA0joPcfN3oi9a7lQuKgdSaYShgrA"}
}
Beispielhafte Response
Schliesslich wird dieses Access-token in jedem Request mitgeschickt.
Die offizielle Dokumentation beschreibt das Ganze noch in mehr Detail.