読み込み中
豆知識
公開している API のグループとエンドポイント数の概要です。詳細は API リファレンス (Scalar UI) で確認してください。
メモ OpenAPI 3.2 仕様で定義された 805 パス (HTTP メソッド換算 943 操作) を 19 のグループに分けています。数値は
/openapi/solo-boss-cloud.openapi.jsonから派生したもので、scripts/check-public-docs-stats.mjsが CI で差分を検出します。グループ分けは Scalar 上のx-tagGroupsで管理しており、ここの並び順とほぼ同じです。
| グループ | ベースパス例 | 主な役割 |
|---|---|---|
| 🏥 System | /api/health /api/cron /api/changelog /api/queue |
ヘルスチェック・クーロン・キュー管理・変更履歴 |
| 🏠 Composite Endpoints | /api/home/init /api/tax-compliance-init/init |
複数のリソースを一度に返す合成エンドポイント (N+1 削減) |
| 🔐 Authentication & User | /api/auth /api/user-profile /api/notifications /api/gamification |
サインイン、トークン更新、プロフィール、通知、XP / 実績 |
| 🏢 Company & Settings | /api/companies /api/accounting-settings /api/bank-accounts /api/establishment-guide /api/members |
会社情報、会計設定、銀行口座、設立支援、チームメンバー / 席 |
| 📄 Documents & Files | /api/documents /api/document-templates /api/folders /api/file-upload /api/file-groups |
書類 CRUD、カスタムテンプレート、フォルダ、アップロード、電子帳簿保存 |
| 👥 Clients | /api/clients /api/client-usage-tracking |
取引先・利用量トラッキング |
| 🤖 AI Features | /api/ai/* /api/ai-business-support /api/advisor /api/openai |
AI 分析、AI Advisor チャット、プロバイダー設定 |
| 🏦 Bank & Reconciliation | /api/bank-statements /api/reconciliation /api/ai-reconciliation |
銀行明細、消込、AI による自動マッチング |
| 💳 Expenses & Reimbursements | /api/expenses /api/expense-wizard /api/expense-claims /api/reimbursement /api/credit-cards |
経費精算、ウィザード、立替申請、クレジットカード |
| 📊 Accounting | /api/accounts /api/journal-entries /api/journal-templates /api/accounting |
勘定科目、仕訳エントリ、仕訳テンプレート、ドック |
| 📈 Financial Reports | /api/reports /api/trial-balance /api/general-ledger /api/reports/amendment-working-paper/export |
損益計算書、貸借対照表、試算表、総勘定元帳、修正申告 WP 出力 |
| 🏠 Assets & Invoices | /api/fixed-assets /api/inventory /api/sales-invoices /api/invoices/qualified |
固定資産、棚卸資産台帳、売上請求書、適格請求書 |
| 📋 Tax & Compliance | /api/tax/* /api/consumption-tax /api/auditor-view /api/multi-office /api/integrity-checks /api/compliance/* |
確定申告、消費税、監査人ビュー / 証憑 ZIP、多拠点（分割法人）、整合性チェック |
| 👔 Payroll & HR | /api/pay-slips /api/employees /api/shataku |
給与明細、従業員、役員社宅 |
| ⚙️ Reference & Settings | /api/reference-data /api/exchange-rates /api/reminders /api/insights |
マスタ、為替、リマインダー、洞察 |
| 🗺️ Maps | /api/map |
Mapbox プロキシ、ストリーミング |
| 📚 Knowledge & Support | /api/knowledge /api/messages |
ナレッジベース、メッセージライブラリ |
| 🛠️ Developer & Admin | /api/admin/* /api/database-docs /api/demo /api/public/demo |
管理ログ、DB ドキュメント、公開デモ |
| 🎮 Simulation | /api/simulation-sessions /api/simulation-templates |
財務シミュレーション (v5.0+) |
すべてのパスとパラメータの詳細は API リファレンス を見てください。
LP やドキュメントサイトから叩いて確認できるエンドポイントです。LP の「いま試せます」(/ の "まず触ってみる") はこの一覧の呼び出しだけで動いています。
| メソッド | パス | レート制限 | 用途 |
|---|---|---|---|
| GET | /api/health |
なし | クイックヘルスチェック (200 / 503) |
| GET | /api/health/live |
なし | ライブネスプローブ (Kubernetes 用) |
| GET | /api/health/ready |
なし | レディネスプローブ |
| GET | /api/public/demo/stats |
calc 制限 (IP 単位) | LP 用の集計統計 (会社数・処理書類数のサンプル) |
| POST | /api/public/demo/classify-journal |
AI 制限 (IP 単位 + AI バジェット) | 銀行明細1行から仕訳の下書きを生成 |
| POST | /api/public/demo/parse-receipt |
AI 制限 (IP 単位 + AI バジェット) | 領収書画像 / PDF から日付・発行元・金額を抽出 |
| POST | /api/public/demo/estimate-tax |
calc 制限 (IP 単位) | 法人税・消費税・住民税の簡易シミュレーション |
| POST | /api/public/demo/provision |
provision 制限 (IP 単位) | LPデモ会社 を挿入し、共有の読み取り専用トークンを返す |
| GET | /api/referrals/validate/:code |
validate 制限 (IP 単位) | サインアップ画面の紹介コード検証。/referrals の他パスは JWT |
税理士共有の公開ビューは、JWT ではなく共有トークンで保護されます。トークンのハッシュ照合・失効・期限・リンク単位の許可（ご確認用資料一式 / 証憑）をサーバー側で検証し、レート制限がかかります。オープンなデモ系とは別枠です。
| メソッド | パス | 認証 | 用途 |
|---|---|---|---|
| GET | /api/public/auditor-view/:token/gate |
共有トークン | 開封前メタデータ。access_count は増やさない |
| POST | /api/public/auditor-view/:token/unlock |
共有トークン + パスフレーズ | HMAC 証明を発行 |
| GET | /api/public/auditor-view/:token |
共有トークン | オーバービュー。成功時に access_count を加算（純粋な読み取りではない） |
| GET | /api/public/document-shares/:token |
共有トークン | 書類ビュー。成功時に access_count を加算 |
| GET | /api/public/auditor-view/:token/audit-pack |
共有トークン（allow_audit_pack） |
ご確認用資料一式 ZIP |
| GET | /api/public/auditor-view/:token/memos |
共有トークン | ご確認事項（修正の経緯） |
| GET | /api/public/auditor-view/:token/evidence |
共有トークン（allow_evidence_view） |
証憑一覧 |
| GET | /api/public/auditor-view/:token/evidence/:file_id |
共有トークン（allow_evidence_view） |
個別証憑のストリーム配信 |
詳細は 税理士共有 を参照してください。
| エンドポイント | 保存される? | 何が記録される |
|---|---|---|
classify-journal |
しない | 入力テキストは応答後に破棄。集計用にカウンタのみ更新 |
parse-receipt |
しない | アップロードされたファイルはメモリ上で処理し、破棄。集計用にカウンタのみ更新 |
estimate-tax |
しない | 入力数値は応答後に破棄。集計用にカウンタのみ更新 |
stats |
- | 公開可能な範囲の集計値のみ返却 |
provision |
する | LPデモ会社 行と lp_demo_attempts を保存。返すトークンは共有の読み取り専用 DEMO_ACCESS_TOKEN |
メモ 上記以外のエンドポイントは原則 Bearer JWT 認証が必要です。例外は、(1) 上の「共有リンク」＝共有トークンで保護される
/api/public/auditor-view/:token/*、(2) サインアップ用のGET /api/referrals/validate/:code（/referralsの他パスは JWT）。年末調整の/api/year-end-adjustment/health/checklist/reference/tax-bracketsは 公開ではありません（default-deny が 401 します）。/api/cron/*はヘッダ秘密鍵 (x-cron-secret)、/api/admin/*は IP allowlist で別系統に保護されています。
ローカルでバックエンドを起動 (npm run dev) すると、localhost:8080 で次のページが見られます。
| URL | 内容 |
|---|---|
/docs/api-reference |
Scalar UI の OpenAPI ブラウザ (このサイトの API リファレンスと同じ仕様) |
/openapi/solo-boss-cloud.openapi.json |
OpenAPI 3.2 仕様 JSON (生のスペック) |
ローカル開発環境の DB スキーマブラウザ |
データベーススキーマブラウザ |
ローカル開発環境の開発者ガイド |
開発者向けガイド (静的 HTML 版) |
ローカル開発環境のミドルウェア一覧 |
ミドルウェア一覧 |
ローカル開発環境のクーロン一覧 |
クーロンジョブ一覧 |
ローカル開発環境の変更履歴 |
変更履歴 |
ローカル開発環境のエラーコード一覧 |
エラーコード一覧 |
本番環境ではこれらのページに認証が必要です。公開ドキュメントは
/docs以下にミラーされているので、まずはこのサイトを使ってください。
読み込み中
豆知識