クイックスタート
クイックスタート
このガイドでは、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 を選択し、リダイレクトフィールドを設定します。
ステップ 3:認証
ユーザーを Adobe IMS 認証エンドポイントにリダイレクトして OAuth フローを開始します:
ユーザーがサインインしてアクセスを承認すると、Adobe IMS は設定されたリダイレクト URI に認証コードをクエリ文字列に含めてユーザーをリダイレクトします。IMS トークンエンドポイントに POST リクエストを送信して、そのコードをアクセストークンと交換します。
リクエストと応答の例とともに、パラメーター定義のリストを以下に示します:
リクエストの例
応答の例
SDK サポート
PythonとTypeScript SDKの両方に、OAuth ハンドシェイク、トークン交換、および自動トークン更新を処理する認証モジュールが含まれています。詳細情報はこちらでご確認いただけます。 Python | TypeScript
ステップ4:最初のAPIリクエストを実行する
アクセストークンを使用して、/v4/me エンドポイントを呼び出すことから始めます:
このリクエストは Adobe IMS API を呼び出して、トークンとユーザー情報を確認します。
リクエストが成功すると、user_id、名前、メールを含む認証されたユーザーの詳細が返されます。これを使用して、認証フローが期待通りに動作していることを確認します。
ほとんどのV4 APIエンドポイントには account_id が必要ですが、これは /v4/me では返されません。account_id を取得するには、/v4/accounts にリクエストを送信します:
これにより、認証されたユーザーが利用できるアカウントのリストが返されます。この応答の account_id を後続のAPIリクエストで使用します。
ユーザーID vs アカウントID
user_id は個人としてのユーザーを識別し、account_id は所属する組織を表します。ほとんどのV4エンドポイントはアカウントレベルで動作します。
次のステップ
認証が設定され、account_id が取得できたら、Frame.io APIの使用を開始する準備が整いました。開始に役立つリソースは次のとおりです: