开放 API 文档

欢迎使用 utm.bar Open API。通过这套 REST 接口，你可以在自己的系统中批量创建短链接、读取点击数据，并将链接管理能力内嵌到 CI/CD 流程、营销自动化工具或内容发布系统中。

你可以做什么

• 创建短链接，支持自定义短码、UTM 参数和可选的过期时间
• 列出并查询团队下的所有链接
• 更新元数据 — 标题、说明、UTM 字段和过期时间
• 禁用 / 启用 / 删除链接
• 读取点击统计，支持按天聚合和时区换算

快速入门

1. 登录控制台，打开一个团队
2. 进入左侧导航的开发者页面，创建一个 API Key
3. 选择所需的权限范围（Scope）
4. 在请求的 Authorization Header（或 X-API-Key）中携带密钥调用 API

基础 URL

https://open.utm.bar/v1

认证方式

每次请求均需携带 API Key：

Authorization: Bearer sk_live_xxxx

或使用兼容 Header：

X-API-Key: sk_live_xxxx

文档目录

• 快速开始 — 5 分钟内创建 API Key 并完成第一次调用
• API 参考 — 全量端点文档，含请求/响应示例

需要帮助？

通过 GitHub Issues 或控制台内联系方式联系我们，我们会认真阅读每一条反馈。