Authentifizierung

Authentifizierung bei der movingimage API mit OAuth 2.0

Die movingimage REST API verwendet OpenID Connect 1.0 und OAuth 2.0 zur Authentifizierung. Die Authentifizierung ist ein mehrstufiger Prozess:

1. Ermitteln des Autorisierungsendpunkts. Der Autorisierungs-Endpunkt ist die URL, an der Sie Ihre Anmeldedaten gegen ein Zugriffstoken austauschen. Sie können den Autorisierungsendpunkt ermitteln, indem Sie den Endpunkt /.well-known/openid-configuration aufrufen.

2. Abrufen eines Zugriffstokens. Verwenden Sie den Autorisierungsendpunkt, um ein Zugriffstoken zu erhalten. Dazu müssen Sie Ihre Anmeldedaten angeben (ein VideoManager Pro-Login oder einen Autorisierungscode).

3. Fügen Sie das Zugriffstoken in Ihre API-Anforderungen ein. Wenn Sie eine API-Anforderung stellen, müssen Sie das Zugriffstoken in den Autorisierungs-Header aufnehmen. Der Autorisierungs-Header muss wie folgt formatiert sein:

Authorization: Bearer <access_token>

4. Aktualisieren Sie das Zugriffs-Token, wenn es abläuft. Zugriffstoken laufen nach einer kurzen Zeit ab. Wenn dies geschieht, müssen Sie das Zugriffstoken aktualisieren. Dies können Sie durch den Aufruf des Endpunkts /oauth/token tun.

Hier ist ein Beispiel für eine API-Anforderung, die die Get VideoManagers-Methode verwendet und ein Zugriffstoken enthält:

GET https://api.movingimage.com/v1/videomanagers
Authorization: Bearer <access_token>

Authentifizierung bei der movingimage API mit OpenID Connect

Um die API nutzen zu können, müssen Sie zunächst wissen, wie Sie sich authentifizieren können.

Wenn Sie VideoManager Pro unter einer benutzerdefinierten Domäne verwenden, können die Endpunkte für die Authentifizierung eines Benutzers ermittelt werden.

Schritt 1: Ermitteln des OpenID Connect Provider-Standorts

Der OpenID Connect Provider-Standort ist die URL, unter der Sie die Authentifizierungsendpunkte anfordern können. Für die große Mehrheit der Kunden lautet der Standort https://api.video-cdn.net/.well-known/webfinger.

Sie können den folgenden curl-Befehl verwenden, um eine Anfrage an diesen Endpunkt zu stellen:

curl https://api.video-cdn.net/.well-known/webfinger?resource=https://api.video-cdn.net/v1/

Die Antwort wird ein JSON-Objekt sein, das die folgenden Informationen enthält:

• Den Standort des Ausstellers: Dies ist die URL des OpenID Connect Providers.

• Der keycloak realm: Dies ist der Name des Keycloak-Realms, den Sie für die Authentifizierung verwenden müssen.

• Die URL des Autorisierungsservers: Dies ist die URL des Autorisierungsservers.

{
    "subject": "https://api.video-cdn.net/v1/",
    "properties": {
        "https://api.video-cdn.net/v1/keycloak/realm": "platform",
        "https://api.video-cdn.net/v1/keycloak/auth-server-url": "https://login.movingimage.com/auth/"
    },
    "links": [
        {
            "rel": "http://openid.net/specs/connect/1.0/issuer",
            "href": "https://login.movingimage.com/auth/realms/platform/.well-known/openid-configuration"
        }
    ]
}

Schritt 2: Ermitteln der Authentifizierungsendpunkte

Der Issuer-Standort, den Sie im vorherigen Schritt erhalten haben, enthält einen Link zu den OpenID Provider-Konfigurationsdaten. Sie können den folgenden curl-Befehl verwenden, um eine Anfrage an diesen Endpunkt zu stellen:

curl https://login.movingimage.com/auth/realms/platform/.well-known/openid-configuration

Die Antwort wird ein JSON-Objekt sein, das die folgenden Informationen enthält:

• Der Autorisierungsendpunkt: Dies ist die URL, unter der Sie Ihre Anmeldedaten gegen ein Zugriffstoken austauschen.

• Der Token-Endpunkt: Dies ist die URL, unter der Sie ein neues Zugangstoken erhalten, wenn Ihr aktuelles Token abläuft.

{
    "authorization_endpoint": "https://login.movingimage.com/auth/realms/platform/protocol/openid-connect/auth",
    "token_endpoint": "https://login.movingimage.com/auth/realms/platform/protocol/openid-connect/token"
}

Verwenden Sie den Autorisierungsendpunkt, um ein Zugriffstoken zu erhalten

Sobald Sie die Authentifizierungsendpunkte entdeckt haben, können Sie den Autorisierungsendpunkt verwenden, um ein Zugriffstoken zu erhalten. Dazu müssen Sie Ihre Anmeldedaten (Benutzername und Passwort) angeben.

Fügen Sie das Zugriffstoken in Ihre API-Anforderungen ein

Wenn Sie eine API-Anforderung stellen, müssen Sie das Zugriffstoken in den Autorisierungs-Header aufnehmen. Der Autorisierungs-Header muss wie folgt formatiert sein:

Authorization: Bearer <access_token>

Aktualisieren Sie das Zugriffstoken, wenn es abläuft

Zugriffstoken laufen nach einer kurzen Zeit ab. Wenn dies geschieht, müssen Sie das Zugriffstoken aktualisieren. Dies können Sie tun, indem Sie eine Anfrage an den Token-Endpunkt stellen.

Zugriffs- und Refreshtoken

Zugriffstoken und Refreshtoken sind eindeutige Kennungen, die zur Authentifizierung von Benutzern und zur Gewährung des Zugriffs auf geschützte Daten verwendet werden.

Zugriffstoken

• Autorisierung für den Zugriff auf API-bereitgestellte Daten

• Begrenzte Gültigkeit, so dass für einen verlängerten Zugriff Refreshtoken erforderlich sind

Refreshtoken

• Generierung neuer Zugriffstoken, wenn vorhandene ablaufen

• Aufrechterhaltung eines nahtlosen Zugriffs ohne wiederholte Authentifizierung

Token-Erwerb

Zugriffs- und Refreshtoken werden nach erfolgreicher Benutzerauthentifizierung ausgegeben. Diese Token werden über die im vorherigen Kapitel beschriebenen Endpunkte bezogen.

Integrationsszenarien

Die Wahl der Token-Erwerbsmethode hängt von der Art der Integration ab. In der nachstehenden Tabelle finden Sie das entsprechende Szenario:

Der Authorization Grant Flow ist der entsprechende OAuth-Mechanismus, der zum Abrufen von Zugriffstokens verwendet wird.