开发者 API 参考手册

极简 RESTful API,两步搞定短链集成。

开发者 API 参考手册

dco.ink 提供了极度精简的 REST API,方便您将短链功能接入到任何应用中。我们的 API 鉴权规则只有两种模式:

模式一:不携带 Token

如果您只是想生成短链接,不在乎后续的管理,直接调用生成接口即可,无需任何鉴权

示例代码

curl -X POST https://api.dco.ink/api/links \
  -d '{"url": "https://example.com/very-long-url"}'
  • 优点:零门槛,即刻生效。
  • 缺点:生成的短链不会出现在您的控制台中,无法追溯和管理。

模式二:携带 Token (需要管理)

如果您希望生成的短链记录在您的账号下,方便日后统计、修改或删除,您需要在请求头中携带从控制台获取的 API Token:

示例代码 (带上 Token)

curl -X POST https://api.dco.ink/api/links \
  -H "Authorization: Bearer dco_YOUR_TOKEN" \
  -d '{"url": "https://example.com/very-long-url"}'

1. 生成短链接

Endpoint: POST https://api.dco.ink/api/links

参数名类型说明
urlstring[必填] 目标长链接。
custom_codestring[选填] 自定义品牌短码。

请求示例 1: 不携带 Token 不需要传 Authorization 头:

curl -X POST https://api.dco.ink/api/links \
  -d '{"url": "https://example.com/very-long-url"}'

请求示例 2: 绑定账号并使用自定义短码 (携带 Token)

curl -X POST https://api.dco.ink/api/links \
  -H "Authorization: Bearer dco_YOUR_TOKEN" \
  -d '{"url": "https://example.com/very-long-url", "custom_code": "mybrand"}'

2. 获取我的短链列表

Endpoint: GET https://api.dco.ink/api/links 获取您账户下创建的所有短链。支持分页查询。

请求示例 (携带 Token):

curl -X GET "https://api.dco.ink/api/links?limit=50&offset=0" \
  -H "Authorization: Bearer dco_YOUR_TOKEN"

3. 修改目标网址

Endpoint: PUT https://api.dco.ink/api/links/:code 更新已有短链的指向。

请求示例 (携带 Token):

curl -X PUT https://api.dco.ink/api/links/mybrand \
  -H "Authorization: Bearer dco_YOUR_TOKEN" \
  -d '{"url": "https://new-url.com"}'

4. 删除短链

Endpoint: DELETE https://api.dco.ink/api/links/:code 彻底销毁指定短链。

请求示例 (携带 Token):

curl -X DELETE https://api.dco.ink/api/links/mybrand \
  -H "Authorization: Bearer dco_YOUR_TOKEN"

响应代码

  • 200/201: 请求成功。
  • 400: 参数错误 (如 URL 不合法)。
  • 401: Token 缺失或无效。
  • 403: 权限不足。
  • 429: 请求过于频繁。