戻る

API ドキュメント

Arrow Suite DOCS REST API v1 — 書類・取引先の CRUD とステータス管理を提供します。

認証

Bearer トークン認証。APIキーは設定画面で発行できます。

レート制限

30リクエスト/分。超過時は 429 を返却します。

対応プラン

Business / Enterprise プランで利用可能です。

認証方法

すべてのリクエストに Authorization ヘッダーが必要です。APIキーは設定 > APIから発行できます。

cURL
curl -H "Authorization: Bearer sk_live_xxxxxxxxxxxx" \
  https://docs.arrow-suite.com/api/v1/documents

レスポンス形式

すべてのレスポンスは統一された JSON 形式で返却されます。

成功レスポンス
{
  "data": { ... },
  "error": null,
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-03-11T09:00:00.000Z"
  }
}
エラーレスポンス
{
  "data": null,
  "error": {
    "code": "NOT_FOUND",
    "message": "書類が見つかりません"
  },
  "meta": {
    "request_id": "...",
    "timestamp": "..."
  }
}

エンドポイント

書類タイプ一覧

type説明
invoice請求書
estimate見積書
receipt領収書
delivery納品書
order発注書
payment支払通知書
expense経費精算書
cover_letter送付状
general汎用書類
aplusA+書類
contract電子契約書
paper_contract紙契約書

ステータス遷移

標準書類

draftissuedpaidcancelled

cancelled → draft で復活可能

電子契約書

draftissuedsentsignedcancelled

OpenAPI 仕様

機械可読な OpenAPI 3.1 仕様を提供しています。ChatGPT Actions、Gemini Function Calling、Claude MCP 等で直接利用可能です。

GET https://docs.arrow-suite.com/api/v1/openapi.json