开发者平台
FabHub 开发者文档是 API、SDK、MCP 工具、Webhook、身份验证及契约参考资料的权威公共入口。此处所有内容均描述由 https://api.fabhub.app/v1 提供的公共接口。
可用内容
- 位于
https://api.fabhub.app/v1的公共 REST API,由 OpenAPI 描述。 - 用于类型化服务端集成的官方 TypeScript SDK(
@fabhub/sdk)。 - 精选的 MCP 服务器(
@fabhub/mcp),其工具与公共 API 作用域一一对应。 - 带签名的出站 Webhook,配有自动生成的 AsyncAPI 事件契约。
- 用于租户自有自动化的 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)。 - 身份验证: 在
X-API-Key标头中发送 API 密钥(或使用Authorization: Bearer)。参见身份验证。 - 金额字段(
salePrice、purchasePrice)为以租户基础货币计的数字,或为null。
核心概念
- 租户(Tenant): 每个凭据都属于一个租户(组织);所有数据均按租户隔离。
- 作用域(Scopes): 密钥携带最小权限作用域,例如
items:read或webhooks:write。 - 幂等性(Idempotency): 写请求接受
Idempotency-Key,因此重试是安全的。参见幂等性。 - 分页(Pagination): 列表为基于页码的分页;审计导出为基于游标的分页。参见分页。
- 错误(Errors): 带有机器可读
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