UrlEdge
开发者

API Reference

把 UrlEdge 直接接进你的系统。通过 REST API,你可以程序化建立、更新和管理 redirect rules,适合内部平台、site migration 流程和代理商批量作业。

Private Beta 权限

UrlEdge API 目前仍为 Private Beta。若你想为工作区申请 API 金钥,请联系支持团队。以下文件可先作为串接规划与评估参考。

验证方式

Bearer Token

请在 Authorization header 中带入 API 金钥来验证请求。你可以在 Console 的设置页面建立工作区层级的 API 金钥。

Authorization: Bearer ue_live_xxxxxxxxxxxxxxxx

端点

POST/v1/redirects- 建立新的 redirect rule
curl -X POST https://api.urledge.com/v1/redirects \ -H "Authorization: Bearer ue_live_..." \ -H "Content-Type: application/json" \ -d '{ "projectId": "p_123", "source": "/github", "destination": "https://docs.urledge.com/get-started", "code": 302 }'
GET/v1/redirects- 列出某个项目下的 redirect rules

支持以 ?page=1&limit=20 进行分页查询。

Webhooks

你可以订阅 redirect.created、domain.verified 等事件。(此功能目前同样处于 Private Beta)