API 仕様書 & 試用環境

すべてのエンドポイントは JSON リクエスト(Content-Type: application/json)を受け付けます。本番エンドポイント(/v1/*)は Authorization: Bearer <YOUR_API_KEY> ヘッダーで認証し、試用エンドポイント(/sandbox/*)はAPIキー不要(毎分20回まで)で利用できます。

対話型 API 試用環境

応答データ
// 「実行する」を押すと結果がここに表示されます
POST /v1/pdf/invoice

1. 日本語 請求書・見積書・領収書 PDF 生成

doc_type(invoice / estimate / receipt)に応じて、インボイス制度対応の日本語PDFバイナリ(application/pdf)を返却します。税率別(10% / 8% / 0%)の消費税は自動計算されます。

cURL リクエスト例
curl -X POST https://jp-biz-api.qlavis-agent.workers.dev/v1/pdf/invoice \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "doc_type": "invoice",
    "document_number": "INV-2026-0042",
    "issue_date": "2026-11-19",
    "due_date": "2026-12-31",
    "issuer": {
      "name": "株式会社サンプル商事",
      "registration_number": "T9000012050000",
      "address": "東京都渋谷区サンプル 1-2-3"
    },
    "recipient": { "name": "合同会社クライアント", "honorific": "御中" },
    "items": [
      { "name": "クラウドシステム開発支援", "quantity": 1, "unit_price": 100000, "tax_rate": 10 }
    ]
  }' --output invoice.pdf
POST /v1/invoice/validate

2. 適格請求書発行事業者登録番号(T番号)検証

T + 13桁の法人番号の形式および国税庁規定のチェックデジットを検証します。

cURL リクエスト例
curl -X POST https://jp-biz-api.qlavis-agent.workers.dev/v1/invoice/validate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"registration_number": "T9000012050000"}'
POST /v1/wareki/convert

3. 西暦↔和暦・日本の祝日・営業日変換

to_wareki(西暦→和暦)および to_seireki(和暦→西暦)に対応。日本の国民の祝日と土日を判定した is_business_day フラグを返します。

cURL リクエスト例
curl -X POST https://jp-biz-api.qlavis-agent.workers.dev/v1/wareki/convert \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date": "2026-11-19", "direction": "to_wareki"}'
POST /v1/zengin/generate

4. 全銀協(Zengin)120バイト固定長振込データ生成

ヘッダ・データ・トレーラ・エンドレコードで構成される全銀フォーマットを生成します。半角カナ変換および小書き文字(ャュョッ)の大文字化・固定長パディングを自動処理します。

cURL リクエスト例
curl -X POST https://jp-biz-api.qlavis-agent.workers.dev/v1/zengin/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "header": {
      "client_code": "0000000001", "client_name": "カ)サンプル",
      "transfer_date": "2026-11-25", "bank_code": "0001", "bank_name": "ミズホ",
      "branch_code": "001", "branch_name": "トウキョウ", "account_number": "1234567"
    },
    "transfers": [{
      "bank_code": "0005", "bank_name": "ミツビシUFJ", "branch_code": "002",
      "branch_name": "シブヤ", "account_number": "7654321", "recipient_name": "ヤマダ タロウ", "amount": 50000
    }]
  }'
POST /v1/text/normalize

5. 法人名・住所・電話番号・カナ表記ゆれ正規化

㈱ / (株) → 株式会社、半角カナ→全角カナ、全角英数→半角英数、1丁目2番3号 → 1-2-3、電話番号のハイフン整形を1回で実行します。

cURL リクエスト例
curl -X POST https://jp-biz-api.qlavis-agent.workers.dev/v1/text/normalize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "㈱サンプル Tech(有)",
    "address": "東京都渋谷区神宮前1丁目2番3号",
    "phone": "0312345678"
  }'
POST /v1/tax/calc

6. 源泉徴収税・印紙税・消費税一括計算

報酬金額に対する源泉徴収税(100万円以下 10.21% / 超 20.42%)、領収書・契約書の印紙税額判定、消費税の端数処理(floor / round / ceil)を返します。

cURL リクエスト例
curl -X POST https://jp-biz-api.qlavis-agent.workers.dev/v1/tax/calc \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100000,
    "tax_rate": 10,
    "tax_mode": "excluded",
    "rounding": "floor",
    "stamp_doc_type": "receipt",
    "mode": "all"
  }'
POST /v1/ogp/render

7. 日本語 OGP 画像生成 (1200×630 SVG/JSON)

記事タイトルとサブタイトルから日本語フォント対応の OGP 画像を生成します。theme: "amber" | "slate" | "indigo" を指定可能。

cURL リクエスト例
curl -X POST https://jp-biz-api.qlavis-agent.workers.dev/v1/ogp/render \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "日本語請求書PDF・全銀データ・和暦をAPI 1本で自動化",
    "subtitle": "Dify / Make / GAS 対応マイクロAPI",
    "theme": "indigo",
    "format": "svg"
  }' --output ogp.svg
POST /v1/gov/*

8. 日本政府・公的機関API 統合エンドポイント

認証不要の公的オープンAPI(即時利用可)と、無料公式APIキーを設定して有効化するアダプタを提供しています。利用時は各省庁の出典表記ルール(出典:e-Gov法令検索(デジタル庁) / 出典:国土地理院 / 出典:気象庁ホームページ)を遵守してください。

公的API エンドポイント一覧
# [認証不要・即時利用可]
POST /v1/gov/law/search          # e-Gov 法令検索 (query, mode: "title"|"keyword")
POST /v1/gov/law/detail          # e-Gov 法令本文取得 (law_id)
POST /v1/gov/geo/geocode         # 国土地理院 ジオコーディング+標高 (address, include_elevation)
POST /v1/gov/weather/forecast    # 気象庁 天気予報JSON (prefecture | area_code)
POST /v1/gov/municipality/lookup # 総務省 全国地方公共団体コード検索 (query | code | pref_code)

# [公式APIキー設定で有効化(未設定時は案内を返却)]
POST /v1/gov/gbiz/company             # 経産省 gBizINFO (GBIZINFO_API_TOKEN)
POST /v1/gov/realestate/transactions  # 国交省 不動産情報ライブラリ (MLIT_REINFOLIB_API_KEY)
POST /v1/gov/estat/search             # 総務省 e-Stat (ESTAT_APP_ID)
POST /v1/gov/edinet/documents         # 金融庁 EDINET v2 (EDINET_API_KEY)

エラーコード一覧

HTTPステータス 意味 対処法
400 Bad Request 入力JSONまたは必須パラメータ不正 レスポンスの error 詳細を確認してください
401 Unauthorized APIキー未指定または無効 Authorization: Bearer ... ヘッダーを確認してください
429 Too Many Requests プランのレート制限または月間上限到達 リトライ間隔を空けるか上位プランへ変更してください
503 Service Unavailable メンテナンスまたは緊急停止中 しばらく時間を置いてから再実行してください