API Keys

Für den Zugriff auf die BPC API gibt es zusätzlich zu dem normalen User Login auch die Möglichkeit, einen API Key zu verwenden. Damit ist eine direkte Authentifizierung beim API Aufruf möglich, ohne diesen muss vor dem Zugriff auf eine API Funktion eine gesonderter Authentifizierungsaufruf getätigt werden.

Ein API Key entspricht einer statischen Session im BPC. Wie eine UserSession enthält diese Attribute wie zugeordnete Organisationen, Rollen, Rechte. Jeder API Key enthält einen definierten Gültigkeitszeitraum. Zusätzlich kann angegeben werden von wem, für wen dieser API Key ausgestellt wurde.

Verwendung des API Keys

Damit das BPC den API Key zur Authentifizierung annimmt, muss dieser im HTTP-Header X-APIKey mitgeschickt werden.

Beispiel

curl --header "X-APIKey: BPC-API-1567679439690" 'http://localhost:8181/cxf/bpc-core/status'

Verwaltung von API Keys

Setting

API Keys können direkt über die Core-Einstellung API_Keys konfiguriert werden. Der Weg über den speziellen Editor (siehe unten) ist zu bevorzugen.

Beispiel Konfiguration API_Keys

{
  "BPC-API-1567758383120": {
    "issuedFor": "Thomas",
    "issuedBy": "bpcadmin",
    "issuedOn": "2019-09-05 12:30:39",
    "expiresIn": "30 days",
    "assignedRoles": [
      "bpcadmin"
    ],
    "assignedRights": [],
    "assignedOrganisations": []
  }
}

Editor / Oberfläche

Alternativ ist eine Konfiguration über die Oberfläche im BPC möglich:

api keys editor

Keywords: