Skip to content

供应商开发者平台

iDataRiver针对商家提供开发者开放平台, 基于此功能商家可以在iDataRiver平台的基础上进行自定义开发, 从而直接使用平台的数据支付安全风控等维度的基础设施,而无需自己实现它们。

功能

供应商开发者平台目前包含以下几部分:

  • 商户开放API
  • 事件回调通知
  • 自定义客服Webhook

商户开放API

文档入口

事件回调通知

你可以在 商户设置 -> 开发者 里的 事件钩子 设置你的全局事件回调url, 出于安全考虑, url必须是基于https的域名链接。

回调字段在第一层均包含event字段, 用来指示当前通知的事件类型, 其余字段根据事件类型不同可能动态变化。

目前event支持以下取值:

  • ORDER_COMPLETED 订单已完成
  • ORDER_REFUND 订单已退款
  • UNDEFINED 未知事件, 理论上不会出现

自定义客服Webhook

目前自定义客服仅针对商户自定义telegram机器人生效。

使用场景

如果用户向商家自定义tg机器人发送普通文字消息, 机器人将此消息通过API传给商家, 商家处理并回复,机器人再商家的回复发给用户。

配置Webhook

你需要提供一个Webhook API, 并将其配置在控制台->商户设置->开发者->自定义客服Webhook

我们会向此API发送一个的HTTPS POST 请求,包含用户唯一id与消息内容,格式如下(application/json):

json
{
    "uid": "202cb962ac59075b964b07152d234b70",
    "content": "你好"
}
  • uid 用户唯一id, 用来帮助区分不同用户
  • content 文本消息

商家在接收到上面的请求时,需要返回一个包含message字段的json结果,我们会直接将message字段内容返回给用户,格式如下:

json
{
    "message": "你好!有什么可以帮助你的吗?"
}
  • message 回复文本内容,请控制在合理长度(如1000字以内)否则可能会回复失败

提示

由于无法确定商户返回的时间,我们限制最多等待60s,如果超时将告知用户处理失败。

当用户发送消息后,我们会立即回复一条客服正在处理中的消息,以免用户重复发送或过早地关闭界面。

如果你需要使用AI模型来处理智能回复,欢迎使用我们的OpenAI中转代理服务

Make things simple and timeproof.