功能定价关于文章文档
开发者

API、SDK、MCP 和 webhook。

开发者平台快速开始身份验证API 参考SDKMCPWebhook错误分页速率限制幂等性更新日志迁移与版本控制策略
原始 API 文档OpenAPI YAMLAsyncAPI YAML
  1. 首页
  2. /
  3. 开发者
  4. /
  5. 快速开始

快速上手

只需几分钟,即可从零开始完成首次经过身份验证的调用。

1. 创建 API 密钥

在应用中打开 Settings -> Integrations -> API,并以集成所需的最小作用域集合(例如 items:read)创建租户 API 密钥。完整密钥(pk_live_... 或 pk_test_...)仅显示一次,请将其存放在服务端的密钥管理器或部署环境中,切勿放入客户端代码或版本控制。


2. 进行首次调用

curl https://api.fabhub.app/v1 \
  -H "X-API-Key: $FABHUB_API_KEY"

GET /v1 返回你的凭据可访问的能力。若要检查凭据本身,其作用域、套餐和速率限制层级,请调用 GET /v1/auth/context:

curl https://api.fabhub.app/v1/auth/context \
  -H "X-API-Key: $FABHUB_API_KEY"
{
  "data": {
    "tenant": { "id": "0e2b...c1", "plan": "pro" },
    "api_key": {
      "id": "key_8f...",
      "prefix": "pk_live_8f3a",
      "environment": "production",
      "scopes": ["items:read", "items:write", "webhooks:write"],
      "rate_limit_tier": "standard",
      "expires_at": null
    }
  }
}

3. 安装 SDK

npm install @fabhub/sdk
import { FabHubClient } from '@fabhub/sdk';

const fabhub = new FabHubClient({ apiKey: process.env.FABHUB_API_KEY });

// List the first page of items
const items = await fabhub.listItems({ pageSize: 20 });
console.log(items.data.length, 'of', items.pagination.total);

// Read your organization
const { data: organization } = await fabhub.getOrganization();
console.log(organization.name, organization.plan);

4. 创建内容(带幂等性)

写调用接受 Idempotency-Key,因此重试的请求永远不会创建重复项:

const { data: item } = await fabhub.createItem(
  { name: 'Widget', itemType: 'product', salePrice: 19.99 },
  { idempotencyKey: crypto.randomUUID() },
);

5. 处理错误

import { FabHubApiError } from '@fabhub/sdk';

try {
  await fabhub.listItems();
} catch (err) {
  if (err instanceof FabHubApiError) {
    console.error(err.status, err.code, err.message);
  }
}

后续步骤

  • API 参考: 每个端点、参数和响应。
  • Webhook: 接收带签名的事件,无需轮询。
  • MCP: 面向 AI 代理工作流的受限工具接口。
首页功能定价关于文章文档开发者
© FabHub隐私与 Cookie条款无障碍