Open Platform
Connect 接入
面向中转服务提供方的 Lime Deep Link 接入说明
Connect 接入
Connect 通过 lime://connect Deep Link,把外部服务下发的 API Key 一键带入 Lime。
当前边界
当前 Connect 文档只覆盖已经落地的运行时边界:
lime://connectDeep Link 参数- 已注册中转商的展示与确认流程
- 可选的统计回调行为
不再在这里承诺额外的审核、灰度或人工接入流程。
基础流程
- 外部服务生成
lime://connect链接 - 用户点击链接后,Lime 解析参数
- Lime 按
relay查询本地已加载的中转商注册表 - 用户确认后,API Key 被保存到 Lime 的当前 Provider 入口
- 若该中转商配置了 webhook,Lime 会异步发送结果回调
Deep Link 协议
lime://connect?relay={relay_id}&key={api_key}&name={key_name}&ref={ref_code}
| 参数 | 必填 | 说明 |
|---|---|---|
relay | ✅ | 中转商唯一标识 |
key | ✅ | 下发给用户的 API Key |
name | ❌ | 在 Lime 中展示的 Key 名称 |
ref | ❌ | 渠道或推广标记,运行时会映射为 ref_code |
运行时行为
relay与key缺失时,Lime 会拒绝该链接- 中转商已在注册表中时,Lime 会展示品牌、链接和协议等信息
- 中转商不在注册表中时,仍会给出未验证提示,但不会自动拥有注册表元数据
- 如果该中转商配置了 webhook,用户确认、取消或失败时会触发异步回调
回调与统计
Connect 回调是可选能力:
- 未注册的中转商不会发送回调
- 注册表中未配置
webhook.callback_url的中转商不会发送回调 - 回调地址必须使用
https://
详细字段见: