3Min API

快速入门

只需3分钟。从注册到第一次 API 测试。

1. 注册

使用 Google 快速注册。每月免费获得1,000次 API 请求。

2. 创建端点

1
仪表盘 → API → 新建端点按钮
2
输入 API 名称
  • 描述为可选项
3
可选设置
  • 必填字段
    • 将特定字段标记为必填。缺少必填字段的请求将被拒绝。
  • Webhook
    • 将数据转发到 Slack 或 Discord 等外部服务。
    • 与协作者 Webhook 独立 — 这是用于您自己的集成。
4
点击创建 API
  • 端点 URL 和 CRUD 方法（POST / GET 单条+列表+搜索 / PUT / DELETE）即时生成
  • 默认 API 密钥自动发放（沙盒密钥立即可用，生产密钥在部署后可用）
  • 同时创建内置测试页面 — 无需额外工具

3. 测试：第一次 API 调用和日志验证

创建端点后立即测试，并在日志中验证接收情况。

仪表盘 → API → 端点详情 → 立即测试按钮
  • 在沙盒环境中测试实际 API 调用
仪表盘 → 日志
  • 验证数据是否正确保存

4. 创建协作密钥 & 通过邮件邀请协作者

所有者测试完成后，创建协作密钥并通过邮件邀请协作者。

仪表盘 → API → 端点详情 → 协作密钥 → 查看全部
  • 点击"添加"创建协作密钥
  • 打开协作密钥详情页发送邮件邀请
  • 受邀协作者可以注册，在自己的仪表盘中查看 API 密钥、日志和统计数据

5. 集成测试

验证协作者能否在沙盒环境中正确调用 API。

  • 协作者在端点详情页查看自己的沙盒 API 密钥
  • 协作者在沙盒环境中测试 API
  • 查看仪表盘 → 日志确认请求数据是否正确接收

6. 把数据取走——Webhook 或轮询

记录不会永远留在这里：生产环境至少保留 60 天，沙盒 30 天。请决定记录如何进入您自己的系统，并在部署前于沙盒中验证。

  • Webhook（推送）：3Min API 会把每条记录发送到您在端点详情页配置的 URL。需要一个能在 15 秒内响应的公网 URL，这是默认选择。
  • 轮询（拉取）：您的客户端循环调用 GET /api/v1/data/<your-slug>/poll，只取回上次调用之后到达的记录。不需要任何入站 URL，因此在笔记本电脑、内网或防火墙之后都能运行。
  • 两者并不互斥——同一个端点可以同时开启。
  • 两者的完整机制见核心概念与 API 集成文档。

7. 部署到生产环境

测试完成后，部署到生产环境。所有者可以直接部署，或批准协作者的部署请求。

仪表盘 → API → 端点详情 → 部署到生产环境按钮
  • 协作者通过端点详情页的"请求部署"按钮请求部署
  • 所有者可以直接部署或审核批准协作者的请求
  • 部署完成后，协作者会自动收到通知并可获取生产环境 API 密钥