Dub.co API 接口详解：短链接管理与高级功能实现指南

项目概述

Dub.co 是一个面向企业的链接管理基础设施，提供创建营销活动、链接分享功能和推荐程序的能力。通过其 API，开发者可以程序化地管理短链接，实现各种高级功能。

API 基础信息

• API 版本：0.0.1
• 许可证：AGPL-3.0
• 服务器地址：http://api.localhost:8888（生产环境）

核心功能解析

1. 创建短链接接口

POST /links 是 Dub.co API 的核心端点，用于创建新的短链接。该接口支持丰富的参数配置：

必填参数

• workspaceId：工作区ID，用于标识所属组织
• url：目标URL，即短链接指向的实际地址

可选参数

• domain：自定义域名，不指定则使用默认域名
• key：自定义短链接后缀（slug），不指定则自动生成
• externalId：外部系统ID，用于与自有系统集成

2. 高级功能配置

Dub.co 提供了多种高级功能，可通过 API 配置：

链接安全控制

• password：设置访问密码
• expiresAt：设置过期时间
• expiredUrl：过期后重定向地址

设备定向

• ios：iOS设备专用目标URL
• android：Android设备专用目标URL

地理位置定向

geo 参数支持按国家代码配置不同的目标URL，覆盖全球200+国家和地区

社交分享优化

• proxy：启用自定义社交卡片
• title/description/image：自定义社交分享内容

技术实现细节

请求认证

API 使用 token 认证机制，需要在请求头中携带有效的访问令牌：

"security": [
  {
    "token": []
  }
]

参数验证

API 实现了严格的参数验证：

• 字符串长度限制（如externalId最长255字符）
• 类型检查（如tagIds支持字符串或数组）
• 必填项检查（如workspaceId）

兼容性处理

API 考虑了向后兼容：

• 保留了已弃用的projectSlug参数
• 同时支持新旧标签ID参数（tagId和tagIds）

最佳实践建议

1. 链接管理：使用externalId关联自有系统，便于后续管理
2. 统计分析：启用publicStats公开统计，便于团队协作
3. A/B测试：利用地理位置和设备定向功能实现精准投放
4. 安全防护：对敏感链接设置密码和过期时间

常见问题解答

Q: 如何批量创建链接？ A: 目前API不支持批量创建，需要循环调用单个创建接口

Q: 自定义slug冲突怎么办？ A: API会返回错误，建议添加随机后缀或使用自动生成

Q: 如何获取链接统计数据？ A: 需要通过其他API端点获取，本文档未包含统计相关接口

总结

Dub.co API 提供了企业级短链接管理能力，通过灵活的配置选项和高级功能，可以满足各种营销和技术需求。开发者可以基于此API构建自动化链接管理系统，或集成到现有营销技术栈中。