API リファレンス

FabHub パブリック API の完全なリファレンスです。ブランド化されたポータルが正規のものですが、機械可読のコントラクトを任意の OpenAPI ビューア（Swagger Editor、Redoc、Postman、または IDE）に読み込むこともできます。

• OpenAPI JSON - OpenAPI YAML

ベース URL

https://api.fabhub.app/v1

規約

• X-API-Key（または Authorization: Bearer）で認証します。認証を参照してください。
• リクエストボディは camelCase キーの JSON です。リストのフィルターは snake_case のクエリパラメータです。
• リストエンドポイントはページベースで、pagination オブジェクトを返します。ページネーションを参照してください。
• 書き込みエンドポイントには Idempotency-Key ヘッダーが必要です。冪等性を参照してください。
• エラーは機械可読の code を持つ安定したエンベロープを使用します。エラーを参照してください。

すべてのエンドポイント

この表は OpenAPI コントラクトから生成され、すべてのパブリック操作とそれに必要なスコープを常に一覧化します。以下のセクションは、最も一般的なリソースについての実例です。リクエストおよびレスポンスのスキーマの網羅的なソースは OpenAPI コントラクトです。

サービス

GET /v1

呼び出し元の認証情報が利用できるケイパビリティ（メソッド、パス、スコープ）を返します。スコープは不要です。

GET /v1/auth/context

呼び出し元の認証情報のテナント、プラン、スコープ、レート制限ティア、有効期限を返します。スコープは不要です。例はクイックスタートを参照してください。

アイテム

GET /v1/items

スコープ: items:read。アイテム（製品、材料、コンボ）を一覧取得します。

curl "https://api.fabhub.app/v1/items?page=1&page_size=2&search=widget" \
  -H "X-API-Key: $FABHUB_API_KEY"

{
  "data": [
    {
      "id": "a1c9...",
      "name": "Blue Widget",
      "sku": "WIDG-BLUE",
      "itemType": "product",
      "salePrice": 19.99,
      "purchasePrice": 8.5,
      "isActive": true,
      "category": { "id": "cat_1", "name": "Widgets" },
      "supplier": { "id": "sup_1", "name": "Acme", "company": "Acme Ltd" },
      "updatedAt": "2026-06-19T14:02:00Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 2, "total": 57, "totalPages": 29 }
}

POST /v1/items

スコープ: items:write。Idempotency-Key が必要です。アイテムを作成します。

curl -X POST https://api.fabhub.app/v1/items \
  -H "X-API-Key: $FABHUB_API_KEY" \
  -H "Idempotency-Key: 0b9c4a2e-..." \
  -H "Content-Type: application/json" \
  -d '{"name":"Blue Widget","itemType":"product","salePrice":19.99}'

作成されたアイテムとともに { "data": { ...item } } を返します。

GET /v1/items/{item_id}

スコープ: items:read。{ "data": { ...item } } を返すか、code: "NOT_FOUND" とともに 404 を返します。

PATCH /v1/items/{item_id}

スコープ: items:write。Idempotency-Key が必要です。作成フィールドの任意のサブセットを受け取り、更新されたアイテムを返します。

アイテムのサブリソース

• GET /v1/items/{item_id}/ingredients（スコープ items:read）- combo / 製造アイテムの構成要素。
• GET /v1/items/{item_id}/suppliers（スコープ items:read）- アイテムにリンクされたサプライヤー。

注文

GET /v1/orders

スコープ: orders:read。

{
  "data": [
    {
      "id": "ord_1",
      "module": "sell",
      "orderNumber": "SO-1042",
      "status": "open",
      "contactId": "con_7",
      "orderDate": "2026-06-18",
      "dueDate": "2026-06-25",
      "siteId": null,
      "priority": "normal",
      "assignedTo": null,
      "contact": { "id": "con_7", "name": "Globex" },
      "site": null,
      "createdAt": "2026-06-18T10:00:00Z",
      "updatedAt": "2026-06-18T10:05:00Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 20, "total": 3, "totalPages": 1 }
}

注文は POST /v1/orders、GET /v1/orders/{order_id}、PATCH /v1/orders/{order_id}（書き込みには Idempotency-Key が必要）に加え、明細項目のための GET /v1/orders/{order_id}/lines（スコープ orders:read）もサポートします。正確なリクエストボディについては OpenAPI コントラクトを参照してください。

連絡先

GET /v1/contacts

スコープ: contacts:read。

各連絡先: id、name、email、phone、company、contactType、country、contactGroup、isPrimaryContact、isActive、updatedAt。

連絡先は POST /v1/contacts、GET /v1/contacts/{contact_id}、PATCH /v1/contacts/{contact_id}（書き込みには Idempotency-Key が必要）もサポートします。フィールドについては OpenAPI コントラクトを参照してください。

組織

GET /v1/organization

スコープ: organization:read。{ "data": { "id", "name", "slug", "plan", "createdAt" } } を返します。ここで plan は free | standard | pro | enterprise です。

使用状況

GET /v1/usage

スコープ: usage:read。現在の請求期間、リクエストの合計（全体およびケイパビリティ別）、残り予算を含むレート制限ティアを返します。レート制限を参照してください。

監査イベント

GET /v1/audit/events

スコープ: audit:read（Enterprise）。カーソルページネーション形式のエクスポート。

{
  "data": [
    {
      "id": "evt_1",
      "actorType": "api",
      "actorId": "key_8f...",
      "action": "item.created",
      "resourceType": "item",
      "resourceId": "a1c9...",
      "metadata": {},
      "ipAddress": "203.0.113.10",
      "createdAt": "2026-06-19T14:02:00Z"
    }
  ],
  "pagination": { "hasMore": true, "nextCursor": { "createdAt": "2026-06-19T14:02:00Z", "id": "evt_1" } }
}

在庫

GET /v1/stock-levels

テナントのアイテムの現在の在庫レベルを返します（必要なスコープは上記の表を、フィルターとレスポンスの形状については OpenAPI コントラクトを参照してください）。

Webhook

ライフサイクルと署名の詳細はすべて Webhook に記載されています。