読み込み中
豆知識
「まず触って、合うか確かめたい」——そう感じた方のためのページです。登録なしで、仕訳の下書き・領収書の読み取り・税額の目安を試せます。
サインアップしなくても触れる公開リソースをまとめています。ログイン後にしか見られない内部ツールやスキャナの出力は、ここには含めていません。
:::publictools の3つのカード — 仕訳の下書き・領収書の読み取り・税額の目安専用の試用ページが必要なときは /tools を開いてください。3つのウィジェットを大きめに並べた、登録なしのサンドボックスです。
| リソース | 用途 |
|---|---|
| 製品トップ | プロダクトの全体概要 |
| 公開ツールページ | 仕訳の下書き・領収書の読み取り・税額の目安をまとめて試せる専用ページ |
| 料金プラン | プラン比較・FAQ |
| セキュリティ | セキュリティ姿勢の概要 |
| 会社設立ガイド | 法人設立から最初の仕訳までの公開チュートリアル |
| 法務情報 | 利用規約 / プライバシーポリシー / 特定商取引法表記 |
| ログイン | サインイン。?signup=1 を付けても同じログイン画面です（クエリは現在無視されます） |
| デモ環境を起動 | ログイン画面の 「デモ環境を起動（読み取り専用）」、または LP の 「サンプル会社で試す」。POST /api/public/demo/provision は LPデモ会社 行を作り、共有の読み取り専用トークンを返します（書き込み可能な 24 時間ワークスペースではありません） |
公開ドキュメントの入口はすべて /docs/... です。バックエンドが起動していなくても見られます。
| リソース | 用途 |
|---|---|
| API リファレンス | Scalar UI で描画した OpenAPI 3.2 仕様 |
| バックエンド概要 | バックエンドの全体像と公開／非公開エンドポイントの境界 |
| データの流れ | 認証・CSRF・ケース変換・検証の順序 |
| エンドポイント早見表 | 19 グループ・943 操作の API カタログ |
| 運用 | クーロン・キュー・レート制限・セキュリティヘッダ |
| データモデル | Prisma スキーマの要約 (224 モデル) |
ここに載っているものだけが、認証なしで叩ける公開エンドポイントです。LP の「まず触ってみる」セクションと /tools ページは、すべて下のテーブルにある呼び出し先で動いています。
| メソッド | エンドポイント | レート制限 | 用途 |
|---|---|---|---|
| GET | /api/health |
なし | クイックヘルスチェック (200 / 503) |
| GET | /api/health/live |
なし | ライブネスプローブ |
| GET | /api/health/ready |
なし | レディネスプローブ |
| GET | /api/public/demo/stats |
calc 制限 (IP 単位 / 15分) | サンプル会社の初期データ件数 (公開画面では件数を表示しません) |
| POST | /api/public/demo/classify-journal |
AI 制限 (IP 単位 / 15分 + AI予算) | 銀行明細1行から仕訳を生成 (AI / ルール照合) |
| POST | /api/public/demo/parse-receipt |
AI 制限 (IP 単位 / 15分 + AI予算) | 領収書画像 / PDF を OCR して構造化 (2MB 上限) |
| POST | /api/public/demo/estimate-tax |
calc 制限 (IP 単位 / 15分) | 簡易税額試算 |
| POST | /api/public/demo/provision |
provision 制限 (IP 単位 / 24時間) | LPデモ会社 (is_lp_demo) を挿入し、共有の DEMO_ACCESS_TOKEN を返す。固有 JWT ではない |
POST /api/public/demo/classify-journal銀行明細を1行渡すと、勘定科目と税区分、仕訳の下書きを返します。先にベンダー名・金額のルール照合を試し、合致しなければ AI が推定します。返却される source は ai | rules、confidence は 0.0–1.0 の信頼度です。
POST /api/public/demo/parse-receipt領収書の画像 (.png / .jpg / .jpeg) または PDF を multipart/form-data で渡すと、日付・発行元・金額・税区分・候補科目を返します。file フィールドが空のとき、filename パラメータからファイル名のパターンだけで簡易抽出する経路もあります。アップロードサイズの上限は 2MB です。
POST /api/public/demo/estimate-taxrevenue (年商) と expenses (経費) を渡すと、課税所得・法人税・消費税・住民税の概算と、納付期限を返します。capitalAmount と isConsumptionTaxRegistered を渡すと中小法人向けの軽減税率や免税事業者判定も含めて返します。本番の確定申告ハブとは前提が異なるため、あくまで目安としてご利用ください。
ローカルでバックエンド (npm run dev、port 8080) を起動した場合のみ参照できる、認証なしのドキュメント URL です。本番ではすべて Bearer 認証 (または Basic 認証) が必要になります。
| URL | 内容 |
|---|---|
/docs/api-reference |
Scalar UI (公開版と同じ仕様) |
/openapi/solo-boss-cloud.openapi.json |
OpenAPI 3.2 仕様 JSON |
ローカル開発環境の DB スキーマブラウザ |
DB スキーマブラウザ |
ローカル開発環境の開発者ガイド |
開発者ガイド (静的 HTML 版) |
ローカル開発環境のミドルウェア一覧 |
ミドルウェア一覧 |
ローカル開発環境のクーロン一覧 |
クーロンジョブ一覧 |
ローカル開発環境の変更履歴 |
変更履歴 |
ローカル開発環境のエラーコード一覧 |
エラーコード一覧 |
solo-boss-cloud-documentation (フロントエンド) のリポジトリで利用できる主要スクリプト:
| コマンド | 用途 |
|---|---|
npm run dev |
Vite 開発サーバー (port 5174) |
npm run build |
本番ビルド (型チェック + Vite ビルド) |
npm run typecheck |
TypeScript 型チェック |
npm run lint |
ESLint |
npm run lint:strict |
ESLint (--max-warnings 0 — CI ラチェット) |
npm run lint:fix |
ESLint auto-fix |
npm run format |
Prettier 整形 |
npm run cap:sync |
Capacitor (iOS / Android) 同期 |
npm run check:openapi |
バックエンドの OpenAPI 仕様と同期しているかを確認 |
npm run check:public-docs-locale |
公開ドキュメントの英語見出し・絵文字・古い Status 行を検出 |
npm run check:public-docs-stats |
公開ドキュメントの数値クレームと OpenAPI/Prisma の差分を検出 |
solo-boss-cloud_backend の主要スクリプト:
| コマンド | 用途 |
|---|---|
npm run dev |
API を tsx watch で起動 (port 8080) |
npm test |
Vitest 単体テスト |
RUN_LIVE_API_TESTS=1 npm test |
Live API smoke / integration テスト |
npm run lint |
ESLint |
npm run test:coverage |
カバレッジ計測 |
npx prisma migrate dev --name X |
新しいマイグレーションを作成 |
npx prisma generate |
Prisma クライアントを再生成 |
以下はアプリ内だけで使えるもので、ログイン後に参照できます。
/dev-reference/* と /docs/dev/* は開発・本番とも 開発者ガイド へリダイレクトします）これらは、開発者プログラムなどを通じて、段階的に公開していく予定です。
読み込み中
豆知識