Schnellstart | Frame.io API Documentation

In diesem Leitfaden wird der schnellste Weg zu Ihrem ersten erfolgreichen Aufruf der Frame.io V4-API erklärt.Sie werden ein Projekt in der Adobe Developer Console erstellen, Anmeldedaten generieren und Ihre erste API-Anfrage stellen.

Schritt 1: Erstellen Sie in Ihrer Adobe Developer Console ein Projekt und fügen Sie die Frame.io V4-API hinzu

Erstellen Sie in der Adobe Developer Console ein neues Projekt und fügen Sie die Frame.io V4-API hinzu.

In diesem Leitfaden wird die OAuth 2.0-Webanwendung für die Authentifizierung verwendet. Informationen zu anderen Authentifizierungsmethoden finden Sie im Authentifizierungsleitfaden.

Schritt 2: Konfigurieren Sie Ihre Anwendung

Wählen Sie als Anwendungstyp „OAuth-Web-App“ aus, und konfigurieren Sie die Umleitungsfelder entsprechend.


Umleitungs-URI	Eine Route in Ihrer Anwendung, die die OAuth-Antwort von Adobe IMS erhält. Nachdem Benutzende sich angemeldet und den Zugriff genehmigt haben, werden sie von Adobe IMS zu dieser URL umgeleitet, wobei in der Abfragezeichenfolge ein Autorisierungscode enthalten ist. Dieser Code wird dann von Ihrer App gegen einen Zugriffstoken eingetauscht.
Muster für Umleitungs-URIs	Muster, die über den Standard-Umleitungs-URI hinaus mit weiteren Umleitungs-URLs übereinstimmen. Dies ist besonders nützlich, wenn Ihre App in verschiedenen Umgebungen oder mit dynamischem Routing verwendet wird. Mehrere Muster sollten als durch Kommas getrennte Liste angegeben werden.

Schritt 3: Authentifizierung

Starten Sie den OAuth-Fluss, indem Sie Benutzende zum Endpunkt der Adobe IMS-Autorisierung umlenken:

  https://ims-na1.adobelogin.com/ims/authorize/v2
  ?client_id={CLIENT_ID}
  &redirect_uri={REDIRECT_URI}
  &scope=offline_access,openid,email,profile,additional_info.roles
  &response_type=code

Nachdem Benutzende sich angemeldet und den Zugriff genehmigt haben, werden sie von Adobe IMS mittels eines Autorisierungscodes in der Abfragezeichenfolge zu Ihrer konfigurierten Umleitungs-URI umgelenkt.Tauschen Sie diesen Code gegen einen Zugriffstoken ein, indem Sie eine POST-Anfrage an den IMS Token-Endpunkt senden.

Es folgt eine Liste der Parameterdefinitionen zusammen mit einer Beispielanfrage und -antwort:

Parameter	Obligatorisch	Beschreibung
code	Ja	Der Wert der Code-Abfragezeichenfolge, der an Ihre `redirect_uri` zurückgegeben wird, wenn Benutzende sich mit Ihrer Anwendung authentifizieren
grant_type	Ja	Dieser Wert sollte immer `authorization_code` lauten.
authorization	Erforderlich für vertrauliche Clients
Beispielanfrage

curl -X POST 'https://ims-na1.adobelogin.com/ims/token/v3' \
  -H 'Authorization: Basic {AUTHORIZATION}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'code={CODE}&grant_type=authorization_code'

Beispielantwort

{
    "access_token": "{ACCESS_TOKEN}",
    "refresh_token": "{REFRESH_TOKEN}",
    "sub": "B0DC108C5CD449CA0A494133@c62f24cc5b5b7e0e0a494004",
    "id_token": "{ID_TOKEN}",
    "token_type": "bearer",
    "expires_in": 86399
}

Unterstützung für SDK

Sowohl die Python- als auch die TypeScript-SDKs enthalten Authentifizierungsmodule, mit denen der OAuth-Handshake, der Tokenaustausch und die automatische Tokenaktualisierung verarbeitet werden.Hier finden Sie mehr zu diesen Themen:

Python | TypeScript

Schritt 4: Erstellen Sie Ihre ersten API-Anfragen

Mit Ihrem Zugriffstoken beginnen Sie mit einem Aufruf des Endpunkts /v4/me:

curl https://api.frame.io/v4/me \
-H "Authorization: Bearer <token>"

Mit dieser Anfrage wird die Adobe IMS API aufgerufen, um Ihren Token und Ihre Benutzendeninformationen zu überprüfen.

Bei einer erfolgreichen Anfrage werden Details über den authentifizierten Benutzer bzw. die authentifizierte Benutzerin zurückgegeben, einschließlich user_id, Name und E-Mail-Adresse. Damit bestätigen Sie, dass Ihr Authentifizierungsfluss wie erwartet funktioniert.

Bei den meisten V4 API-Endpunkten ist eine account_id erforderlich, die nicht von /v4/me zurückgegeben wird. Damit Sie Ihre account_id erhalten, stellen Sie eine Anfrage an /v4/accounts:

curl https://api.frame.io/v4/accounts \
-H "Authorization: Bearer <token>"

Dadurch wird die Liste der Konten zurückgegeben, die für authentifizierte Benutzende verfügbar sind.Verwenden Sie in nachfolgenden API-Anfragen die account_id aus dieser Antwort.

Benutzenden-ID und Konto-ID

Anhand Ihrer user_id werden Sie als Einzelperson identifiziert. Ihre account_id repräsentiert die Organisation, der Sie angehören.Die meisten V4-Endpunkte arbeiten auf der Kontoebene.

Nächste Schritte

Nun, da die Authentifizierung vorhanden ist und Sie Ihre account_id haben, können Sie mit der Frame.io-API arbeiten.Diese Ressourcen können Ihnen beim Einstieg helfen: