开发者文档

Basemulti 提供了强大的 REST API 和 Webhook 功能，让您能够轻松地将 Basemulti 集成到您的应用程序中。本文档将帮助您了解如何使用这些功能。

API 概述

Basemulti 的 API 遵循 RESTful 设计原则，提供了以下功能：

• 记录的增删改查操作
• 批量操作支持
• 字段过滤和排序
• 分页查询
• 关联数据查询

API 认证

所有的 API 请求都需要进行认证。Basemulti 使用 Header Token 认证机制：

x-bm-token: your_api_token

您可以在工作区设置中生成和管理 API Token。

基础 URL

API 的基础 URL 格式如下：

https://your-domain.com/api

响应格式

所有的 API 响应都使用 JSON 格式，并包含以下基本结构：

{
  // 响应数据
}

错误处理

当发生错误时，API 会返回相应的 HTTP 状态码和错误信息：

{
  "message": "错误描述"
}

Webhook 概述

Webhook 允许您在特定事件发生时接收通知。支持的事件包括：

• 记录创建
• 记录更新
• 记录删除
• 手动触发

Webhook 配置

您可以为每个表格配置多个 Webhook，每个 Webhook 可以：

• 选择要监听的事件类型
• 设置目标 URL

Webhook 请求格式

当事件触发时，Webhook 会发送 POST 请求到您配置的 URL，请求体包含：

{
  "type": "record.create",
  "created_at": "2024-12-09T20:32:45.534Z",
  "data": {
    "base_id": "base_id",
    "table_name": "table_name",
    "records": [
      // 事件相关数据
    ]
  }
}

后续步骤

• 了解如何使用记录列表 API
• 学习记录详情 API的使用
• 掌握记录创建 API
• 探索记录更新 API
• 使用记录删除 API
• 配置和管理 Webhook