Authentifizierung
Die primedocs Web API verwendet OAuth 2.0 mit Bearer Tokens zur Authentifizierung. Clients müssen in der primedocs.config registriert sein, bevor sie Access Tokens anfordern können.
Übersicht
Die Authentifizierung erfolgt über den im primedocs enthaltenen Identity Server (IdS). Nach der Registrierung eines Clients kann dieser ein Access Token über den client_credentials Grant Type anfordern.
Das Access Token muss dann im Authorization-Header aller API-Aufrufe mitgegeben werden:
Authorization: Bearer <access_token>
Client-Registrierung
Um einen Client zu registrieren, muss ein Eintrag in der primedocs.config vorgenommen werden. Siehe primedocs.config für Details.
Token-Anfrage
Access Tokens werden vom Token-Endpunkt angefordert:
POST https://{instanz}/ids/connect/token
Der Request-Body muss folgendes enthalten:
client_id— die registrierte Client-IDclient_secret— das Client-Secretgrant_type— mussclient_credentialsseinscope— der benötigte Scope (z.B.pd_AdminWebApioderpd_ConnectWebApi)
API-Scopes
| Scope | Beschreibung |
|---|---|
pd_AdminWebApi | Zugriff auf die Admin API für administrative Operationen |
pd_ConnectWebApi | Zugriff auf die Connect API und Connect Session API für die Dokumentgenerierung |
Beispiele
Vollständige PowerShell-Beispiele zur Anforderung und Verwendung von Access Tokens finden Sie auf den einzelnen API-Seiten: