Valu-Up のデータ・機能にプログラマティックにアクセスするための REST API リファレンスです。 Webhook連携・データ同期・カスタムダッシュボード構築などにご利用ください。
APIエンドポイントは以下のいずれかの方式で認証します:
Session認証(ブラウザ)
ログイン済みブラウザからのリクエストは自動的に認証されます。
https://hs-platform-five.vercel.app/api/ai/reportAIによる企業価値レポートを生成(Claude Sonnet 4)
リクエストボディ:
{
"inputs": {
"annualRevenue": 180000000,
"grossProfit": 90000000,
"operatingIncome": 30000000
}
}レスポンス例:
{
"report": "<markdown report>",
"modelVersion": "claude-sonnet-4-20250514"
}/api/parse-financial決算書PDFをAIで解析して財務指標を抽出
リクエストボディ:
multipart/form-data: file=<PDF>
レスポンス例:
{
"annualRevenue": 180000000,
"grossProfit": 90000000,
"operatingIncome": 30000000,
"employeeCount": 15
}/api/freeefreee OAuth認証を開始(リダイレクト)
/api/freee/plfreeeから損益計算書データを取得
/api/mfMFクラウド OAuth認証を開始(リダイレクト)
/api/mf/plMFクラウドから損益計算書データを取得
/api/teamsユーザーが所属する全チームを取得
/api/teams新しいチームを作成
リクエストボディ:
{ "name": "営業部", "description": "..." }/api/teams/inviteチームメンバーを招待
リクエストボディ:
{
"teamId": "uuid",
"email": "user@example.com",
"role": "member"
}/api/export?format=csvデータをCSVでエクスポート(UTF-8 BOM付き)
/api/export?format=xlsxデータをExcel形式でエクスポート
/api/export?format=jsonデータをJSON形式でエクスポート
/api/audit-log監査ログを取得(最大500件)
/api/keys発行済みAPIキーの一覧を取得
/api/keys新しいAPIキーを発行(初回のみ平文を返却)
リクエストボディ:
{ "name": "My App Integration" }レスポンス例:
{
"id": "uuid",
"name": "My App Integration",
"key": "vup_live_xxxxxxxxxx"
}/api/keys?id={id}APIキーを削除(失効)
/api/webhook/slackユーザー設定のSlack Incoming Webhookに通知送信
リクエストボディ:
{
"webhookUrl": "https://hooks.slack.com/...",
"title": "企業価値更新",
"message": "EVが閾値を超えました",
"color": "good" | "warning" | "danger"
}/api/status全システム稼働状況を取得(公開)
| コード | 意味 | 対処 |
|---|---|---|
| 400 | Bad Request | リクエストボディを確認 |
| 401 | Unauthorized | 認証情報を確認 |
| 403 | Forbidden | 権限不足。管理者に確認 |
| 404 | Not Found | リソースが存在しない |
| 429 | Rate Limit | しばらく待ってリトライ |
| 500 | Server Error | サポートへご連絡 |
| 502 | Bad Gateway | 外部サービス不調。少し待ってリトライ |
ご不明点は サポート窓口 または info@hsconsulting-strategy.com までご連絡ください。