API 概要（仕様の要点まとめ）
Re:port Flow API の主要な事実を 1 ページで確認できるリファレンスです。値は各詳細ページ（一次情報）と整合させており、確定的な内容は「一次情報」列のリンク先を参照してください。数値が食い違う場合は一次情報が優先します。
料金・データ取扱い・解約などのサービス事実は、ランディングページのサービス事実表（英語） / サービス事実表（日本語）に集約しています。本ページは API に固有の事実のみを扱います。
基本情報
| 項目 | 値 | 一次情報 |
|---|---|---|
| ベース URL | https://api.re-port-flow.com/v1 | 認証方法 |
| API バージョン | v1（パスに含む） | 認証方法 |
| プロトコル | HTTPS のみ（HTTP は HTTPS へリダイレクト）／ 最小 TLS 1.2・推奨 TLS 1.3 | 制限事項 |
| データ形式 | 入力：JSON（テンプレート変数へマッピング）／ 出力：PDF | PDF 生成ガイド |
| ヘルスチェック | GET /v1/health/check（認証不要・ログ非記録） | 制限事項 |
| データ保管地 | AWS 東京リージョン（Asia Pacific (Tokyo), ap-northeast-1）、日本国内 | サービス事実表 |
認証方式には何がある？
appkey ヘッダ認証と OAuth 2.0 / OpenID Connect の2方式です。単一ワークスペースの自動化なら appkey、外部サービスにユーザー単位で認可させるなら OAuth を選びます。
| 方式 | 用途 | 一次情報 |
|---|---|---|
appkey ヘッダ | 単一ワークスペースの自動化（cURL、社内バッチ） | API キー管理 |
| OAuth 2.0 Client Credentials | サーバー間連携（バックエンド → Re:port Flow） | OAuth 2.0 認証 |
| OAuth 2.0 Authorization Code + PKCE | ユーザー個別の認可（Make.com・外部 SaaS・個人アプリ・MCP） | OAuth 2.0 認証 |
OAuth スコープの一覧（openid / profile / designs:read / designs:write / templates:read / templates:write / pdf:generate）と指定方法は OAuth 2.0 認証 を一次情報とする。API キーは 3 ヶ月ごとのローテーションを推奨。
エンドポイント
| エンドポイント | メソッド | 用途 | 一次情報 |
|---|---|---|---|
/file/sync/single | POST | 単一 PDF を同期生成 | 単一PDF同期生成 |
/file/sync/multiple | POST | 複数 PDF を同期生成（ZIP） | 複数PDF同期生成 |
/file/async/single | POST | 単一 PDF を非同期生成 | 単一PDF非同期生成 |
/file/async/multiple | POST | 複数 PDF を非同期生成 | 複数PDF非同期生成 |
/file/download/{requestId} | GET | 生成物（リクエスト単位）のダウンロード | ダウンロード |
/file/download/{requestId}/{fileId} | GET | 個別 PDF のダウンロード | ダウンロード |
/file/status/{requestId} | GET | 生成状態（queued / processing / completed / failed）と失敗理由 | 生成状態の取得 |
/file/design/parameter/{designId} | GET | テンプレートのパラメータ構造取得 | テンプレートのパラメータ取得 |
/file/designs | GET | テンプレート一覧の取得（ページネーション付 き・MCP 向けディスカバリ） | テンプレート一覧の取得 |
完全なエンドポイント一覧・スキーマは OpenAPI 仕様（openapi/content-service.yaml）を一次情報とします。本表は主要エンドポイントのサマリです。
レート制限・サイズ上限・タイムアウトは？
同期エンドポイントは 30 requests/分・タイムアウト 60 秒（60 秒を超えうる処理は非同期）、非同期は 100 requests/分・タイムアウトなしです。リクエストサイズはどちらも 50MB（Base64 エンコード後）が上限です。
| 項目 | 値 | 一次情報 |
|---|---|---|
| レート制限（同期） | 30 requests/分・ワークスペース単位（/sync/*） | 制限事項 |
| レート制限（非同期） | 100 requests/分・ワークスペース単位（/async/*） | 制限事項 |
| レート制限（ダウンロード・取得） | 100 requests/分・ワークスペース単位（/download/*, /design/parameter/*, /designs） | 制限事項 |
| レート制限（状態確認） | 300 requests/分・ワークスペース単位（/status/*） | 制限事項 |
| 超過時 | 429 Too Many Requests＋Retry-After ヘッダ（RFC 9110 §10.2.3） | 制限事項 |
| リクエストサイズ上限 | 50MB（Base64 エンコード後、実質約 37MB 相当） | 制限事項 |
| タイムアウト（同期） | 60 秒（/sync/*）。超えると API の手前のロードバランサーが 504 を返す | 制限事項 |
| タイムアウト（非同期） | なし | 制限事項 |
レート制限・サイズ・タイムアウトの確定的な値と挙動は制限事項を一次情報とします。本表はサマリです。
サンプル（追試可能）
| サンプル | 検証観点 | 一次情報 |
|---|---|---|
| Invoice (English) | 英数字表示 / 通貨・小数点2桁 / 明細配列 | サンプル集 |
| 請求書 / 見積もり / 労働者名簿 / 秘密保持誓約書 ほか | 複数明細・税計算・日付・長文条項 等 | サンプル集 |
各サンプルは入力 JSON・実行例（curl / Node.js / Python）・検証済み出力 PDF を GitHub: reportflow-examples で公開しています（対応 API バージョン v1）。