创建新端点

概述

端点是一个可以接收外部系统 JSON 数据的 URL。3Min API 存储传入的数据、记录日志，并可选择通过 Webhook 转发。

在此页面，您只需输入名称、描述和可选的必填字段即可创建端点。必填字段可以稍后在详情页修改，因此可以先跳过。

创建后

• 自动在沙盒环境中创建
• 立即签发沙盒环境 API 密钥（tm_test_ 前缀）
• 同时签发生产环境 API 密钥（tm_live_），但在部署前生产环境调用将被拒绝且不记录日志
• 自动生成公开的集成指南页面链接（Swagger 风格测试 + 代码示例）

如何进入

• 仪表盘右上角的 新建端点 按钮
• 左侧菜单 APIs → 列表页右上角的 创建新 API 按钮

---

基本信息

API 名称

必填字段。

• 用于区分端点的用户可见名称
• 实际 API 路径（Slug）自动生成，因此请选择能反映数据性质的名称
  • 推荐示例：contact-form、order-notification、wine-shop-sale
  • 避免使用：test、api1、my endpoint
• 约束条件：
  • 不能为空
  • 同一账户内名称不能重复
  • 有最大长度限制（超出时显示错误信息）

描述

可选字段。

• 端点用途的自由文本描述
• 记录该端点何时被调用、接收什么样的数据，方便协作者和未来的自己查阅
• 示例："结账完成时触发的订单确认通知"
• 之后可在详情页内联编辑

必填字段

可选。可以随时在详情页添加。

预定义 API 调用中必须包含的 JSON 字段。如果定义的字段在请求中缺失，调用将被拒绝。

每个条目的输入字段

• 字段名：字段键（例如 order_id、customer_email）
• 数据类型：从 String、Number、Boolean、Object、Array 中选择
• 可搜索：勾选后可在日志页面用该字段作为搜索关键词
• 字段描述（可选）：与协作者分享的描述

约束条件

• 可搜索仅适用于 String 类型字段
• 可搜索每个端点最多限 2 个字段
• 字段名必须以字母或下划线开头，只能包含字母、数字和下划线
• 不允许重复的字段名

验证方式

仅检查 JSON 中是否存在该键——不验证值的内容或格式。

现在可以跳过

如果未定义必填字段，端点将接受任何 JSON Payload。先创建端点，在沙盒环境中测试，确定需要哪些字段后，再在端点详情页面添加。

此页面上没有的功能

• Webhook 设置 — 创建后在端点详情页配置
• 通知设置 — 同样在详情页
• 协作密钥管理 / 邀请 — 在详情页的协作密钥中管理
• 生产环境部署 — 使用详情页的 部署到生产环境 按钮

创建后

点击 创建 API 后自动跳转到端点详情页。从那里继续：

1. 在概览卡片上查看实际端点 URL
2. 使用默认 API 密钥测试沙盒环境调用
3. 根据需要设置 Webhook / 通知 / 协作密钥
4. 准备好上线后，使用 部署到生产环境 进行部署

---

常见问题

• 之后可以改名吗？ — 可以，随时在详情页概览中编辑名称和描述
• 需要多个端点吗？ — 大多数情况下不需要。3Min API 使用文档式存储，您可以将嵌套 JSON 作为一个 Payload 发送到单个端点。只有当事件本质不同时（例如订单 vs. 咨询）才需要拆分端点
• 需要定义严格的必填字段吗？ — 先不定义，与协作者一起测试，然后只添加确实必须始终存在的字段