APIキー、権限、テストモード
ひとことで言うと
ProとTeamでは、ダッシュボード > ドメインとAPIでAPIキーを作成します。キーには権限(読み取りのみ、読み取りと書き込み、フルアクセス)とモードがあります。本番キー(pf_live_)は実際に動作し、テストキー(pf_test_)は誰にもメールを送らず、転送は24時間後に期限切れになります。
Pandafile APIを使うと、自分のアプリ、スクリプト、サーバーから、ファイルを送ったり、アップロードを集めたり、署名を依頼したりできます。APIはProとTeamに含まれ、ウェブサイトと同じ制限が適用されます。すべてはAPIキーから始まります。
キーを作成する
- ログインして、ダッシュボード > ドメインとAPIを開きます。
- 「APIキー」でキーに名前を付けます。たとえば「ウェブサイトのアップロード」などです。
- キーのモード(本番またはテスト)と、キーの権限(フルアクセス、読み取りと書き込み、読み取りのみ)を選びます。
- 「キーを作成」を押し、すぐにキーをコピーします。セキュリティのため、キーが表示されるのは一度だけです。
- リクエストのたびに、Authorization: Bearer の後ろにキーを付けたヘッダーで送ります。
有効なキーは最大10個まで持てます。本番キーはpf_live_、テストキーはpf_test_で始まります。開発者ガイドはpandafile.co/developers、APIリファレンスはpandafile.co/developers/apiにあります。
権限:キーでできること
- 読み取りのみ:GETリクエストだけ。キーで情報を調べることはできますが、何も変更できません。
- 読み取りと書き込み:読み取りのみの内容に加えて、転送、ファイルリクエスト、署名リクエスト、Webhookサブスクリプションの作成、変更、削除ができます。
- フルアクセス:ブランディングやチームの招待などのアカウント設定を含め、すべてができます。
テストモード
- pf_test_キーで作った転送はテストデータです。追加した受信者を含め、誰にもメールは送られません。
- テスト転送は、作成から24時間後に必ず期限切れになり、延長できません。
- 制限、ストレージ、利用量にはまったく数えられず、通常の転送一覧にも表示されません。
- テスト転送に関するWebhookイベントはlivemodeがfalseになり、Slack、Microsoft Teams、Discordには送られません。
- 一部の操作は本番キーでしか使えません。テストキーで実行すると、APIはtest_mode_unsupportedエラーを返します。
キーを安全に保つ
- キーを持っている人は誰でも、あなたのアカウントからファイルを送れます。キーはサーバーに置き、ウェブサイトやアプリの公開コードには絶対に含めないでください。
- キーが漏れたかもしれないときは、ダッシュボード > ドメインとAPIで取り消してください。そのキーを使うアプリはすぐに動かなくなり、そのキーで作られたWebhookサブスクリプション(ZapierやMakeなど)も停止します。
- キーごとにレート制限があります。現在の状況は、すべてのレスポンスのRateLimitヘッダーで確認できます。
- チームでは、APIキーは個人のものです。メンバーはそれぞれ自分のキーを作成します。