Authentifizierung
Die Virtimo BPC API bietet verschiedene Möglichkeiten, um sich für den Aufruf von Endpunkten zu authentifizieren. Je nach Anwendungsfall und Systemkonfiguration stehen unterschiedliche Methoden zur Verfügung, um sichere Zugriffe zu gewährleisten. Auf dieser Seite finden Sie eine Übersicht der unterstützten Authentifizierungsverfahren und deren primäre Einsatzzwecke.
Verfügbare Authentifizierungsmethoden
Das BPC unterstützt drei grundlegende Arten der Authentifizierung an der API. Wählen Sie die passende Methode basierend auf Ihrer Systemlandschaft und den Sicherheitsanforderungen aus.
API Keys
Ein API Key entspricht einer statischen Session im BPC und enthält Attribute wie zugeordnete Organisationen, Rollen und Rechte.
Diese Methode wird standardmäßig für den Aufruf von API-Endpunkten sowie für die Konfiguration von Deployment Systemen empfohlen.
Die Authentifizierung erfolgt direkt beim API-Aufruf durch die Übergabe des Keys im HTTP-Header X-APIKey.
Weitere Informationen und Konfigurationsdetails finden Sie unter API Keys.
Access-Tokens
Ein Access-Token wird von einem konfigurierten Open-ID-Connect-Provider zur Verfügung gestellt.
Wie eine reguläre User-Session enthält dieser Token Attribute wie zugeordnete Organisationen, Rollen und Rechte.
Ein ausgestellter Access-Token ist in der Regel nur für eine kurze Zeitspanne gültig.
Die Übermittlung erfolgt in Form eines Bearer-Tokens im Authorization-Header.
Weitere Informationen finden Sie unter Access-Tokens.
Benutzeranmeldung
Für den Zugriff auf die BPC API gibt es neben den API Keys auch die Möglichkeit der klassischen Anmeldung per Benutzername und Passwort. Ohne einen API Key muss bei dieser Methode vor dem Zugriff auf eine API-Funktion zwingend ein gesonderter Authentifizierungsaufruf getätigt werden. Beachten Sie unbedingt, dass diese Art der Anmeldung nicht verwendet werden kann, wenn ein OIDC-basierter Identity Provider zum Einsatz kommt. Weitere Informationen und ein exemplarisches Vorgehen finden Sie unter API Authentifizierung per Benutzeranmeldung.
