認証

概要

Frame.io API で API 呼び出しを行うには認証が必要です。Frame.io API では、認証に次の 2 つの選択肢があります。

• 開発者トークン：生成した個々のユーザーと同じアクセス権と権限を持つ永続的なベアラートークンです。
• OAuth 2 承認コードフロー：Frame.io ユーザーは自分の資格情報を使用してログインし、外部アプリケーションに自分に代わってアクションを行う権限を付与できます。

API を使用するすべてのアクションは、どちらのタイプの認証で実行された場合でも、最終的にベアラートークンヘッダーを使用し、スコープで制御されます。

プロジェクトに最適な認証タイプはどちらか？

プロジェクトの開始に当たっては、開発者トークンの使用をお勧めします。

__開発者トークン__は、各ユーザーのアカウントに関連付けられており、トークンを作成したユーザーと同じアクセス権限を持ち、スコープで制限されます。

次のような用途に最適です。

• 実験（すぐに作成および破棄できるので）
• 単一のアカウント／ユーザーコンテキストを介してすべてのアクションを実行できる統合シナリオ

__OAuth コードフロー__は、複数の異なるユーザーに代わってアクションを実行する必要のある外部ホスト型アプリケーションに適しています。OAuth を使用したベアラートークン管理ではオーバーヘッドが少々多めなので、まず開発者トークンを試してから、後で OAuth アプリにリファクタリングすることも珍しくありません。

開発者トークン

1. Frame.io ユーザー資格情報を使用して、Frame.io 開発者ポータルにログインします。
2. ようこそ画面が表示されます。新しい開発者トークンを作成するには、「トークンを作成」ボタンをクリックします。
3. トークン画面が表示されます。「新規」をクリックします。
4. 新規トークンの画面で、トークンの説明とスコープを入力する必要があります。「説明」には、トークンの使用目的がわかりやすい説明を入力することをお勧めします。「スコープ」では、このトークンに持たせるアクセススコープを正確に選択できます。この手順では、「すべてのスコープを選択」をクリックします。必要に応じて、後でより具体的な権限や特権を持つトークンを作成できます（詳細については「スコープ」を参照）。
5. 下にスクロールして、「作成」ボタンをクリックします。成功すると、トークンに関する情報の概要を示すページが表示されます。
6. 「トークン」フィールドに表示されている文字列をコピーします。これが新しいトークンです。安全な場所に保管してください — これがあなたのアカウントへのアクセス権を表しています。このページから移動すると、二度と表示できなくなります。 この段階で、選択したスコープでトークンを作成したことを確認するメールが届きます。

新しいトークンのテスト

トークンが作成されたので、ベアラー認証を使用してリクエストを試してみましょう。基本的なリクエストで、あなたに関する情報を取得します。

$
curl -H "Authorization: Bearer <YOUR_TOKEN>" https://api.frame.io/v2/me

レスポンスでは、ユーザーレコードの JSON 表現が返されます。

完了しました。Frame.io API 呼び出しを初めて実行しました。🎉

OAuth 2 とは？

OAuth 2.0 は一般的な認証プロトコルの 1 つで、ユーザーが資格情報を直接共有することなく、アプリケーションどうしが制限された形でやり取りできるようにします。このプロセスは通常、特別なログイン画面を介したユーザーへの「アクセス権の付与」とみなされます。

OAuth 2 承認コードフロー

OAuth 2 承認コードフローを採用すると、外部アプリケーションへの限定的なアクセス権を付与できます。アプリケーションは、Frame.io では開発者ポータルへの登録時に、初期設定に基づき特定の権限をリクエストします。ユーザーがリクエストを承認すると、外部アプリはそのユーザーに代わって操作ができます。

OAuth 2 承認コードフローの基本については、こちらをご覧ください：OAuth 2 承認コードフローの設定

OAuth 2 の詳細

OAuth 2 の詳細については、次のリソースを参照してください。

• OAuth 2
• 承認コードフロー