开发必读

开发必读

特别说明:不需要的字段请不要传null值,请将null值字段忽略掉。

申请接口资料说明

在云帆ERP系统店铺管理下的外部接口申请页面中填写相关信息后申请接口权限。填写完成后,联系客服进行审核。
特别说明:此文档仅针对推送到云帆的接口。

数据格式定义

  • 数据编码采用UTF-8格式,application/json格式
  • 采用HTTP或HTTPS传输协议,POST方法

接口必须参数

Headers必须参数

字段 类型 默认 注释
sign string 签名,MD5(app_id + PostBody + appSecret)

将请求的结构体转json后,进行MD5签名,签名字符串放在请求Header

PostBody数据必须字段

字段 类型 默认 注释
app_id string 系统中申请的app_id
msg_id string 消息id,请保证唯一性,重复id不处理
timestamp long 0 当前请求时间戳(毫秒)
data object null 参考各个接口相应传输数据结构体

开发说明

  1. 系统支持设置访问IP白名单,可在外部接口申请中设置。
  2. 每次请求的时间戳务必使用当前时间戳。
  3. 签名格式为MD5(app_id + PostBody + appSecret)转小写,其中appSecret是外部接口申请的页面中查看。
  4. msg_id 请保证唯一性,否则将不进行处理,并返回错误。