開発者プラットフォーム
FabHub 開発者ドキュメントは、API、SDK、MCP ツール、Webhook、認証、コントラクトのリファレンス資料に関する正規のパブリックな入り口です。ここに記載されている内容はすべて、https://api.fabhub.app/v1 から提供されるパブリックサーフェスを説明しています。
利用できるもの
- OpenAPI で記述された
https://api.fabhub.app/v1のパブリック REST API。 - 型付きサーバーサイド連携のための公式 TypeScript SDK(
@fabhub/sdk)。 - パブリック API スコープと 1 対 1 で対応するツールを備えた、厳選された MCP サーバー(
@fabhub/mcp)。 - 生成された AsyncAPI イベントコントラクトを持つ、署名付きのアウトバウンド Webhook。
- テナント所有の自動化のための API キーと、承認済みパートナーアプリケーションのための OAuth。
規約
- ベース URL:
https://api.fabhub.app/v1。このリファレンス内のすべてのパスはこれを基準とした相対パスです。 - 形式: リクエストおよびレスポンスのボディは JSON で、リクエストボディは
camelCaseのキーを使用します。 - クエリパラメータは
snake_caseを使用します(例:page_size、contact_types)。 - ID は UUID 文字列です。タイムスタンプは UTC の ISO 8601 です(例:
2026-06-20T09:30:00Z)。 - 認証: API キーを
X-API-Keyヘッダー(またはAuthorization: Bearer)で送信します。認証を参照してください。 - 金額フィールド(
salePrice、purchasePrice)はテナントの基準通貨での数値、またはnullです。
中核となる概念
- テナント: すべての認証情報は 1 つのテナント(組織)に属します。すべてのデータはテナント単位にスコープされます。
- スコープ: キーは
items:readやwebhooks:writeなどの最小権限スコープを持ちます。 - 冪等性: 書き込みリクエストは
Idempotency-Keyを受け取るため、リトライが安全です。冪等性を参照してください。 - ページネーション: リストはページベース、監査エクスポートはカーソルベースです。ページネーションを参照してください。
- エラー: 機械可読の
codeを持つ安定した JSON エンベロープ。エラーを参照してください。
現在のコントラクトのスナップショット
- OpenAPI バージョン:
1.0.0 - パブリック操作数: 47
- パブリックスコープ数: 15
- Webhook チャネル数: 14
- MCP ツール数: 45
ここから始める
ダウンロード可能なコントラクト
公開可能なソースドキュメント
このポータルは、docs/developer-platform/docs-source-registry.json に登録された公開可能な開発者プラットフォームのソースから生成されます。
docs/developer-platform/api-changelog.mddocs/developer-platform/enterprise-controls.mddocs/developer-platform/hosted-mcp.mddocs/developer-platform/openapi-breaking-change-policy.mddocs/developer-platform/scope-taxonomy.mddocs/developer-platform/usage-endpoint.mddocs/developer-platform/webhook-events.mddocs/developer-platform/versioning-and-deprecation.md