API Authentifizierung
Diese Seite beschreibt, wie mit dem Calenso API kommuniziert werden kann.
- Du hast eine Enterprise Calenso-Lizenz
- Du hast das "API-Keys"-Modul lizenziert
Calenso stellt den Support der Auth0 Authentifizierung via OAuth2 per 01. November 2023 ein. Kunden, welche Access-Tokens über
https://calenso.eu.auth0.com/oauth/token generieren, müssen ihre Projekte bis zu diesem Datum migrieren, um einen Unterbruch zu vermeiden.Hier sind einige Vorteile, welche die Migration mit sich bringt:
- Einfacherer API Zugriff: Neu muss nur noch der Header X-Api-Key mit dem entsprechenden Schlüssel gesetzt werden. Das Generieren eines Access-Tokens entfällt, was den Zugang schneller und unkomplizierter macht.
- Keine Limits mehr für M2M-Tokens: Die bisherige Beschränkung von 30 M2M-Tokens pro Monat wurde aufgehoben, sodass Sie mehr Flexibilität genießen können.
- Individuelle Rollenzuweisung: Eigene Rollen können nun API-Schlüsseln zugewiesen werden, was eine personalisierte und optimierte Nutzung unserer Dienste ermöglicht.
Navigiere zu https://dashboard.calenso.com/app/settings/manage-api-keys und klicke auf "Generieren".
Definiere, welche Rolle der API-Key haben soll und klicke auf "Speichern".
Anschliessend kannst du dir den Key über die 3 Punkte "Kopieren" lassen. Er sollte mit
x-calenso-.... anfangen.Damit dein API-Request authentifiziert werden kann, musst du für jeden Request den folgenden Header setzen:
Key: X-Api-Key
Value: [dein generierter API-Key]
Calenso unterstützt momentan noch verschiedene Auth-Anbieter (u.a. Auth0). Damit die korrekte Authorisierungslösung greift, benötigt es in einer Übergangsphase noch den folgenden Header. Nach dem 01. November 2023 kann dieser entfernt werden.
Key: X-Calenso-Auth
Value: true
Beispiel:
X-Api-Key: xcalenso-8faccd4c-6b87-4289-xxxx-f756e04a08a1X-Calenso-Auth: true- PROD:
https://api.calenso.com/v1/ - Entwicklungssystem für Kunden:
https://api.calenso.io/api/v1/ - Entwicklungssystem für Calenso:
https://dev.my.calenso.com/api/v1
Last modified 1mo ago