短链接API使用指南

不久前,我们更新了短链接API的功能,在原有开放API的基础上增加了更多高级功能。

使用小码短链接的开放API功能,可以让你的产品快速接入短链接能力,我们通过此文为你介绍短链接API的使用方式。

开通短链接API功能

使用短链接API之前,需要开通短链接API权限,登录后进入小码短链接管理后台,在顶部导航栏点击「开放API」,点击页面上的立即开通按钮即可开启短链接API权限。

-w1120

绑定自有域名(非必须)

如果您有自己的域名,我们建议使用小码短链接的自定义域名功能,将您的域名解析到小码短链接,从而实现生成自己域名下短链接的功能。

设置原始链接域名白名单

为了避免短链接功能被滥用,我们设置了原始域名白名单,您需要将原始链接域名添加到此白名单中,域名需要完全匹配,例如原始链接为 http://a.b.interval.im/xyz 则须提交 a.b.interval.im,否则无法调用成功。

如果您绑定了自定义域名,则不需要添加白名单。

-w949

调用接口生成短链接

根据小码短链接API文档调用接口生成短链接。

调用接口获取访问数据

除了获取短链接分组、生成短链接接口外,我们还提供了:

  1. 编辑短链接:可修改短链接跳转网址;
  2. 获取短链接访问数据:获取短链接的访问数据概览;
  3. 获取短链接访问记录:根据分页参数获取短链接访问记录。

使用 Webhook 获取访问通知

当您的短链接被访问时,小码短链接会将访问数据发送到您设置的地址上,您可以在此地址中处理相应的业务逻辑。

-w1044