Authorization

Um mit der viewneo-API zu kommunizieren, benötigen Sie ein gültiges Access Token im Authorization Header der Anforderung.

Personal Access Token

Wenn man im Namen des eigenen Kontos auf die API zugreifen möchten, muss ein persönliches Personal Access Token generiert werden. Dieses geschieht in den API-Einstellungen im viewneo-Konto. Durch Klick auf die Schaltfläche "Neues Token generieren" wird ein Token erstellt und angezeigt. Der Token wird für die Anwendung benötigt, die auf viewneo zugreifen soll und sollte an einen sicheren Ort aufbewahrt (gespeichert) werden.

Nach der Benennung des Tokens (Beschreibung), wird dieser in einem Fenster angezeigt.

Gültigkeit des Token

Persönliche Zugriffstoken sind gültig, bis Sie sie in Ihrem API-Dashboard entfernen.

Wichtig: Personal Access Token sollten wie Passwörter behandelt und mit niemanden geteilt werden.

OAuth2

Für den Zugriff auf die Viewneo-API im Auftrag eines Benutzers kann OAuth2 verwendet werden, um ein Zugriffstoken abzurufen. Um diese Funktion verwenden zu können, muss in den viewneo API-Einstellungen einen OAuth-Client erstellt werden.

So erhält man einen Authorization Code (1. - 3.)

Um einen Autorisierungscode zu erhalten, muss der Benutzer dem Client für den Zugriff auf sein Konto autorisieren.

Um den Benutzer auf die Autorisierungsseite umzuleiten, müssen zuerst die URL erstellt werden. Fügen Sie die folgenden Schlüsselwertparameter (key-value parameters) als Query String zur folgenden Basis-URL hinzu

https://cloud.viewneo.com/oauth/authorize

Key	Value
client_id	Id des OAuth Client
redirect_uri	'Url encoded' Callback-URL für den Redirect des Users nach der Anmeldung. Wichtig: Dieser Wert muss mit der Umleitungs-URL übereinstimmen, die in den Client-Einstellungen festgelegt wurden
response_type	code

Eine gültige Umleitungs-URL (redirect url) sieht z.B. wie folgt aus:

https://cloud.viewneo.com/oauth/authorize?client_id=9&redirect_uri=https%3A%2F%2Fexample.com%2Fcallback&response_type=code

So kann eine Antwortseite der Redirect URL aussehen.

Nachdem der Benutzer den Client autorisiert hat, wird er zur Weiterleitungs-URL umgeleitet, wobei der Autorisierungscode als get-Parameter mit dem Namen code angehängt wird.

{
  "grant_type": "authorization_code",
  "client_id": "YOUR CLIENT ID",
  "client_secret": "YOUR CLIENT SECRET",
  "redirect_uri": "https://example.com/callback",
  "code": "YOUR AUTHORIZATION CODE"
}

CURL Beispiel:

curl -H "Content-Type: application/json" -X POST -d '{"grant_type": "authorization_code","client_id": "YOUR CLIENT ID","client_secret": "YOUR CLIENT SECRET","redirect_uri": "https://example.com/callback","code": "YOUR AUTHORIZATION CODE"}' https://cloud.viewneo.com/oauth/token

Wenn alles richtig war, sollte die Antwort wie folgt aussehen. Anderenfalls erhält man eine nützliche Fehlermeldung.

{
  "token_type": "Bearer",
  "expires_in": 1296000,
  "access_token": "SOME ACCESS TOKEN",
  "refresh_token": "SOME REFRESH TOKEN"
}

Refresh eines abgelaufenen Token

Wenn der Zugriffstoken aktualisiert werden soll, bevor es abläuft, sendet man einfach den folgenden JSON String an die OAuth-Token-URL:

https://cloud.viewneo.com/oauth/token

Die Zeichen innerhalb der Anführungsstriche müssen mit den eigenen Daten ersetzt werden:

{
  "grant_type": "refresh_token",
  "refresh_token": "YOUR REFRESH TOKEN",
  "client_id": "YOUR CLIENT ID",
  "client_secret": "YOUR CLIENT SECRET",
}

CURL Beispiel:

curl -H "Content-Type: application/json" -X POST -d '{"grant_type": "refresh_token","refresh_token":"YOUR REFRESH TOKEN",client_id": "YOUR CLIENT ID","client_secret": "YOUR CLIENT SECRET"}' https://cloud.viewneo.com/oauth/token

Beispiel: Verwenden des Access Token

Sobald man ein gültiges Zugriffstoken erhalten hat, kann man wie hier gezeigt eine einfache Curl-Anfrage Playlisten abzurufen. Der Platzhaltet YOUR_ACCESS_TOKEN muss durch den echten Token ersetzt werden.

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' 'https://cloud.viewneo.com/api/v1.0/playlist'