クイックスタート

このガイドでは、Frame.io V4 API 呼び出しを初めて成功させるための最速のパスについて説明します。Adobe Developer Console でプロジェクトを作成し、資格情報を生成して、初回の API リクエストを実行します。

ステップ 1：Adobe Developer Console でプロジェクトを作成し、Frame.io V4 API を追加する

Adobe Developer Console から新しいプロジェクトを作成し、Frame.io V4 API を追加します。

このガイドでは、認証に OAuth 2.0 Web App を使用します。他の認証方法については、認証ガイド を参照してください。

ステップ 2: アプリケーションの構成

アプリケーションタイプとして OAuth Web App を選択し、リダイレクトフィールドを設定します。


Redirect URI	Adobe IMS から OAuth レスポンスを受け取るアプリケーション内のルート。ユーザーがサインインしてアクセスを承認すると、Adobe IMS は認証コードをクエリ文字列に含めてこの URL にリダイレクトし、アプリはそれをアクセストークンと交換します。
Redirect URI pattern	デフォルトのリダイレクト URI 以外の追加のリダイレクト URL に一致するパターン。アプリが複数の環境で実行されたり、動的ルーティングを使用したりする場合に便利です。複数のパターンはカンマ区切りリストとして指定する必要があります。

ステップ 3：認証

ユーザーを Adobe IMS 認証エンドポイントにリダイレクトして OAuth フローを開始します：

  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

ユーザーがサインインしてアクセスを承認すると、Adobe IMS は設定されたリダイレクト URI に認証コードをクエリ文字列に含めてユーザーをリダイレクトします。IMS トークンエンドポイントに POST リクエストを送信して、そのコードをアクセストークンと交換します。

リクエストと応答の例とともに、パラメーター定義のリストを以下に示します：

パラメーター	必須	説明
code	はい	ユーザーがアプリケーションで認証する際に `redirect_uri` に返されるコードクエリ文字列の値
grant_type	はい	値は常に `authorization_code` である必要があります
authorization	機密クライアントに必要	`Basic` 認証ヘッダー文字列。リテラルの `Basic` という単語の後に、`clientID:clientSecret` の Base64 エンコード文字列が続きます

リクエストの例

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'

応答の例

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

SDK サポート

PythonとTypeScript SDKの両方に、OAuth ハンドシェイク、トークン交換、および自動トークン更新を処理する認証モジュールが含まれています。詳細情報はこちらでご確認いただけます。 Python | TypeScript

ステップ4：最初のAPIリクエストを実行する

アクセストークンを使用して、/v4/me エンドポイントを呼び出すことから始めます：

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

このリクエストは Adobe IMS API を呼び出して、トークンとユーザー情報を確認します。

リクエストが成功すると、user_id、名前、メールを含む認証されたユーザーの詳細が返されます。これを使用して、認証フローが期待通りに動作していることを確認します。

ほとんどのV4 APIエンドポイントには account_id が必要ですが、これは /v4/me では返されません。account_id を取得するには、/v4/accounts にリクエストを送信します：

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

これにより、認証されたユーザーが利用できるアカウントのリストが返されます。この応答の account_id を後続のAPIリクエストで使用します。

ユーザーID vs アカウントID

user_id は個人としてのユーザーを識別し、account_id は所属する組織を表します。ほとんどのV4エンドポイントはアカウントレベルで動作します。

次のステップ

認証が設定され、account_id が取得できたら、Frame.io APIの使用を開始する準備が整いました。開始に役立つリソースは次のとおりです：