REST API v1

API リファレンス & インタラクティブ Playground

すべてのエンドポイントは JSON リクエスト(Content-Type: application/json)を受け付け、Authorization: Bearer <YOUR_API_KEY> ヘッダーで認証します。

インタラクティブ API Playground

Output
// 「リクエスト実行」を押すと結果がここに表示されます
POST /v1/pdf/invoice

1. 日本語請求書 PDF 生成

インボイス制度(適格請求書)に準拠した日本語PDFバイナリ(application/pdf)を返却します。税率別小計・消費税額はサーバー側で自動計算されます。

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 '{
    "invoice_number": "INV-2026-0042",
    "issue_date": "2026-11-19",
    "due_date": "2026-12-31",
    "issuer": {
      "name": "株式会社サンプル商事",
      "registration_number": "T1234567890123",
      "address": "東京都渋谷区〇〇 1-2-3"
    },
    "recipient": { "name": "合同会社クライアント 御中" },
    "items": [
      { "description": "クラウドシステム開発支援", "quantity": 1, "unit_price": 100000, "tax_rate": 0.1 }
    ]
  }' --output invoice.pdf
POST /v1/invoice/validate

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

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

cURL / GAS / Dify 共通ペイロード
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": "T1234567890123"}'
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/ogp/render

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

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

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・和暦・OGPをAPI 1本で自動化",
    "subtitle": "Dify / Make / GAS 対応マイクロAPI",
    "theme": "light",
    "format": "png"
  }' --output ogp.png

エラーコード一覧

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