Pandafile · 毎週50 GB無料

アプリやワークフローのためのファイル転送API

PandafileにはREST APIがあり、自社のコードやサーバー、ノーコードツールから大容量ファイルを送れます。転送を作成し、再開可能なアップロードでファイルを送り、受信者に専用リンクをメールで届け、誰かがダウンロードしたらWebhookで受け取れます。APIはProとTeamに含まれ、Webアプリと同じ制限が適用され、公開されたOpenAPI 3.1ドキュメントで仕様が記述されています。テストキーを使えば、実際のメールを送ったりストレージを消費したりせずに開発やテストができます。

開発者ガイドを読む

OpenAPI 3.1で記述されたREST API

すべてのエンドポイントは/api/v1の下にあり、JSONでやり取りします。認証は、AuthorizationヘッダーにBearerトークンとしてAPIキーを指定します。キーはダッシュボードで作成し、表示されるのは一度だけです。権限は読み取り専用、読み取りと書き込み、フルアクセスから選べるので、レポート用のスクリプトに転送を削除する権限を与えずに済みます。API全体は機械可読なOpenAPI 3.1ドキュメント(/api/v1/openapi.json)で記述されており、Postmanに読み込んだり、クライアントを生成したり、AIコーディングアシスタントに渡したりできます。/developersの開発者ガイドでは基本的な考え方を、/developers/apiのAPIリファレンスでは全エンドポイントを例付きで解説しています。すべてのレスポンスにはリクエストIDが付き、レート制限はRateLimitヘッダーで通知され、一覧はカーソル方式のページネーション、エラーは共通のJSON形式です。

tusによる再開可能なアップロード

大きなファイルや不安定なネットワークは、1本の長いHTTPリクエストとは相性がよくありません。ファイルを送るには、まずPOST /api/v1/transfersで転送を作成し、ファイル、タイトル、メッセージ、必要に応じて受信者のメールアドレスを指定します。その後、各ファイルを再開可能なアップロードのためのオープンなプロトコルであるtusでアップロードします。接続が切れてもサーバーが再起動しても、最初からではなく最後のバイトから再開できます。JavaScript、Python、Go、Java、.NET、Swiftなど、すぐに使えるtusクライアントが揃っています。すべてのファイルが揃ったらcompleteを呼び出すと、転送は通常のPandafileリンクになり、ダウンロードページ、受信者ごとの専用リンク、リマインダー、有効期限が付きます。プランの制限はブラウザと同じで、Proなら1回の転送で最大1000 GB、ストレージは1500 GBです。

URLから直接ファイルを送信

ファイルがすでに別の場所にあることもあります。CRMの添付ファイル、レンダーファームの出力、別サーバー上のエクスポートなどです。POST /api/v1/transfers/from-urlにHTTPSのURLを渡すと、Pandafileがファイルを取得し、転送の作成から完了までを行います。リクエストは最大20秒待機します。小さなインポートは完了した状態で返り、大きなものはステータスuploadingですぐに返り、インポートはバックグラウンドで続きます。進捗はGET /api/v1/transfers/{id}/importで確認するか、transfer.readyのWebhookを待つだけでもかまいません。ZapierやMakeとの連携も、この仕組みでワークフロー側にファイルをダウンロードさせることなく送信しています。

Webhookと通知

ポーリングする代わりに、イベントを購読しましょう。Pandafileは、転送の準備完了・ダウンロード・期限切れ、受信者による承認や修正の依頼、ファイルリクエストへのアップロード、署名依頼の完了といったタイミングで、指定したURLを呼び出します。各配信はPandafile-SignatureヘッダーでHMAC-SHA256の署名が付くので、本当に私たちから届いたものか確認できます。配信に失敗した場合は、1分後、5分後、30分後、2時間後、12時間後に再試行します。イベントは30日間保持され、GET /api/v1/eventsで取得できます。コードが不要なら、同じイベントをSlack、Microsoft Teams、Discordにメッセージとして投稿することもできます。

テストキー、安全な再試行、その他の自動化

APIキーには2つのモードがあります。本番用キーはpf_live_、テストキーはpf_test_で始まります。テストキーで作成した転送はメールを一切送らず、ストレージや使用量にもカウントされず、保持期間は24時間だけで、通常の転送一覧にも表示されません。そのため、副作用なしに本物のAPIに対して結合テストを実行できます。POSTとPATCHのリクエストはIdempotency-Keyヘッダーに対応しているので、リクエストを再試行しても転送が二重に作成されることはありません。転送以外にも、受信者とリマインダー、ダウンロード履歴、リンクの統計と承認、ファイルリクエスト、署名依頼、ブランディング、チームへの招待をAPIで扱えます。APIは月額$5.99または年額$49.99からのPro、月額$14.99または年額$129.99からのTeamに含まれています。チームでは、メンバー一人ひとりが自分専用のキーを持ちます。

よくある質問

PandafileにAPIはありますか?

はい。Pandafileには/api/v1の下にREST APIがあり、転送の作成、ファイルのアップロード、受信者・ファイルリクエスト・署名依頼の管理、Webhookの受信ができます。ProプランとTeamプランに含まれています。

APIのドキュメントはどこにありますか?

開発者ガイドは/developers、例付きの完全なAPIリファレンスは/developers/apiにあります。機械可読なOpenAPI 3.1ドキュメントは/api/v1/openapi.jsonで公開しています。

接続が切れてもアップロードを再開できますか?

はい。ファイルは再開可能なアップロードのためのtusプロトコルでアップロードされるため、中断しても最初からやり直さず、止まったところから続きます。

実際のメールを送らずにテストできますか?

はい。pf_test_で始まるテストキーを使ってください。テスト用の転送はメールを一切送らず、ストレージや使用量にもカウントされず、24時間後に削除されます。

すでにオンラインにあるファイルを送れますか?

はい。POST /api/v1/transfers/from-urlがHTTPSのURLからファイルを取得し、転送にします。大きなインポートはバックグラウンドで続き、リンクの準備ができるとtransfer.readyのWebhookでお知らせします。

開発者ガイドを読む

人気