認証 (Authentication)
すべての API リクエストには、Authorization ヘッダーに Bearer トークンを含める必要があります。
Authorization: Bearer eyJhbGciOiJFZERTQS...
API キーの作成
- Docwize にログインし、New > API KEY MANAGEMENT > API Key Management に移動します
- Add new key をクリックします
- 名前を入力し、必要なスコープを選択します
- トークンをすぐにコピーしてください — トークンは一度しか表示されず、後で再取得することはできません
このスクリーンのポータル操作の全体像については、API キー管理を参照してください。
トークンのペイロード
JWT には以下のクレームが含まれます。
| クレーム | 型 | 説明 |
|---|---|---|
company_login | string | このトークンが認証対象とする組織コードです。すべての API リクエストは、この組織のデータに限定されます。 |
scope | string | 付与されたスコープのカンマ区切りリストです（例："documents_read,documents_write,search"）。トークンがアクセスできるエンドポイントを決定します。 |
token_type | string | "user" または "full_control" のいずれかです。user トークンは、関連付けられたユーザーのドキュメント権限を継承します。full_control トークンは、すべてのドキュメントに対して無制限のアクセス権を持ちます。 |
user_email | string or null | user トークンの場合、トークンが権限を継承するユーザーのメールアドレスです。full_control トークンの場合は null になります。 |
name | string | API キーの作成時に付けられた、人間が読める名前です。 |
exp | integer | Unix エポックタイムスタンプによるトークンの有効期限です。この時刻を過ぎて行われたリクエストは 401 で拒否されます。 |
スコープ
各エンドポイントには特定のスコープが必要です。スコープリストに full_control を含むトークンは、すべてのスコープチェックをバイパスします。
| スコープ | アクセス対象 |
|---|---|
documents_read | ファイル情報の取得、ダウンロード、ダウンロード URL の取得、バージョン履歴、List Folders、Schema Fields、Schema Values |
documents_write | ドキュメントのアップロード、新しいバージョンのアップロード、ファイルの更新、Create Folder、Move Folder、Delete Folder |
search | Search |
トークンの失効
トークンは、New > API KEY MANAGEMENT > API Key Management でキーのトグルを無効にすることで、いつでも失効させることができます。失効したトークンは、次回の API 呼び出し時に即座に拒否されます — 猶予期間はありません。