認証
すべてのAPIリクエストにはAPIキーが必要です。X-API-KeyヘッダーまたはAuthorization: Bearerヘッダーで渡すことができます。
一部のアカウントエンドポイント（アカウント情報、取引履歴、使用量、支払い履歴）はウェブアプリログインのJWTセッショントークンもサポートしており、デベロッッパーポータルアクセスに便利です。
X-API-Keyヘッダーの使用
curl -H "X-API-Key: chu_live_xxxxxxxx" \
https://your-domain.com/api/v1/account
Authorization Bearerの使用
curl -H "Authorization: Bearer chu_live_xxxxxxxx" \
https://your-domain.com/api/v1/account
APIキーの作成
- PROOFウェブアプリにログインします
- 開発者ポータル（
/developer）に移動します - キー作成をクリックします
- 名前を入力します（例: "production"、"staging"）
- 完全なキー値をコピーします — 一度のみ表示されます
API経由でもキーを作成できます:
curl -X POST https://your-domain.com/api/v1/keys \
-H "Authorization: Bearer <your-jwt-token>" \
-H "Content-Type: application/json" \
-d '{"name": "production", "scopes": ["jobs:read", "jobs:write"]}'
注意
APIキーを安全に保管してください。ソース管理にコミットしたり、クライアントサイドコードに公開しないでください。
APIキースコープ
| スコープ | 説明 |
|---|---|
jobs:read | ジョブステータスの読み取りと一覧 |
jobs:write | ジョブのアップロード、確認、変換 |
レート制限
- デフォルト: APIキーあたり分間60リクエスト
- 同時ジョブ: アカウントあたり最大5件（管理者設定可能）
- 日次クレジット割り当て: キーごとにオプション
超過した場合、APIは429 Too Many RequestsとRetry-Afterヘッダーを返します。