コンテンツにスキップ

APIキーの発行方法

FilmaのAPIを利用するには、管理画面でAPIユーザーを作成し、APIキーを発行する必要があります。

前提条件

  • Filma管理画面へのアクセス権限が必要です
  • 組織の管理者権限が必要です

APIキー発行手順

1. 管理画面にログイン

  1. ブラウザでFilma管理画面にアクセス https://filma.biz/filmaadmin/

  2. 管理者アカウントでログイン

2. APIユーザーの作成

  1. 管理画面の左側メニューまたはダッシュボードから「ユーザー一覧」をクリック

  2. 「新しいユーザーを追加する」ボタンをクリック

  3. ユーザー情報を入力：

  4. e-mail: 空欄でも可（APIユーザーの場合）
  5. 氏名: API利用用途が分かる名前を入力（例：「外部サイト連携用」「モバイルアプリ用」）

  6. APIユーザー: ✅ チェックを入れる

  7. 「送信」ボタンをクリック

3. APIキーの確認とAPI種類の設定

  1. ユーザー作成後、自動的にユーザー詳細画面に遷移

  2. APIキー欄に自動生成されたAPIキーが表示される

  3. 例：a1b2c3d4e5f6789a

  4. このAPIキーをコピーして保存

  5. API種類を確認：

  6. 読取専用 (readonly): デフォルト設定

  7. フルアクセス (fullaccess): 編集権限が必要な場合

  8. API種類を変更する場合は「編集」ボタンをクリック

4. ドメインアクセス制限の設定

APIキーを特定のドメインからのみ利用可能にするため、アクセス許可ドメインを設定します。

  1. ユーザー詳細画面で「API設定編集」ボタンをクリック

  2. アクセス許可ドメインに利用するドメインを1行1つずつ入力： example.com api.example.com mobile-app.example.com

  3. API種類を必要に応じて変更：

  4. 読み取り専用 (readonly): データの取得のみ可能

  5. 読み書き可能 (fullaccess): データの取得・更新・削除が可能

  6. 「保存」ボタンをクリック

5. APIキーの利用

発行されたAPIキーを使用してAPIにアクセスできます：

# 例: ファイル一覧の取得
curl "https://filma.biz/filmaapi/storage?api_key=a1b2c3d4e5f6789a"

重要な注意事項

  1. APIキーの管理
  2. APIキーは外部に漏らさないよう厳重に管理してください

  3. 特にfullaccess権限のAPIキーは細心の注意が必要です

  4. ドメイン制限

  5. アクセス許可ドメインが未設定の場合、他のドメインからのアクセスが拒否されます

  6. Filmaのドメインからのアクセスは常に許可されます

  7. 権限による機能制限

  8. readonly権限: 公開ファイルの参照のみ

  9. fullaccess権限: 全ファイルの参照・編集（show_all=trueパラメータ使用時）

  10. APIキーの削除・再発行

  11. 必要に応じてユーザー一覧からAPIユーザーを削除できます
  12. 新しいAPIキーが必要な場合は新しいAPIユーザーを作成してください

トラブルシューティング

よくあるエラーと対処法

401 Unauthorized

  • APIキーが正しく指定されていない
  • APIキーが無効または削除されている
  • JWTトークンが無効または期限切れ

403 Forbidden (domain access denied)

  • APIキー認証でアクセス許可ドメインが設定されていない
  • APIキー認証で現在のドメインが許可リストに含まれていない
  • （注：JWT認証ではドメイン制限は適用されません）

403 Forbidden (fullaccess required)

  • fullaccess権限が必要な操作をreadonly権限で実行しようとしている

404 Not Found

  • 公開されていないファイルにアクセスしようとしている（readonly権限の場合）
  • 存在しないファイルIDを指定している

JWT認証エラー

  • トークンの形式が無効
  • トークンの有効期限が切れている
  • 組織のシークレットキーが一致しない