接口调用规则

注:本文已停止更新,请移步至新开发文档获取最新信息

所有接口均由【全渠道】主动向【自建商城】接口发起请求,通过验证签名的方式保证接口安全性。自建商城接口回调地址在【网店信息-编辑网店-api地址】配置,建议将其配置成 https 的地址。验签所用到的appKeyappSecret也能在新增自建商城成功后的编辑页面中查看,如下图所示:
图片

注: 自建商城接口开发者收到全渠道的接口请求后需按照文档中的参数格式给全渠道返回信息。
【api地址】需要填写真实地址,不能填写接口文档或demo上的示例地址。必须是以https://http:// 开头的完整全路径地址,并且确保url中的域名和IP是外网可以访问的,不能填写localhost127.0.0.1192.168.x.x等本地或内网IP。

请求说明

  • 所有 API 请求方式均为 POST
  • 请求头:Content-Type=application/json;charset=utf-8

参数说明

本文档接口参数分为两类: 第一类:请求参数,包含系统参数和业务参数;第二类:响应参数

系统参数

请求所有接口均携带的参数,用于系统身份认证和数据安全校验。系统参数包括:

参数名 类型 参数描述
appKey string 新建自建商城类型的网店后,全渠道分配的appKey
method string 调用的API方法名称
param string 业务参数](#业务参数)json序列化字符串,具体参数根据不同的API方法而定
timestamp string 时间戳(格式:2024-01-01 12:00:00
v string 版本,默认1.0
sign string 签名,32位长度的字符串,获取规则详见签名规则
{
  "appKey": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
  "method": "open.goods.list.get",
  "param": "{\"Offset\":0,\"Size\":1,}",
  "timestamp": "2024-10-29 10:48:00",
  "v": "1.0",
  "sign": "E3B0C44298FC1C149AFBF4C8996FB924"
}

业务参数

业务参数是指调用具体某个接口时需要的和业务相关的参数,通常不同的接口有不同的业务参数。业务参数统一使用 JSON 字符串表示,如业务请求参数中包含OffsetSize字段,则传入方式如下:

{
   "Offset":0,
   "Size":1,
}

响应参数

所有接口响应均为 JSON 格式。接口响应有统一的格式:

成功格式

{
  "code": "success",
  "message": "成功",
  "data":{} //响应数据,json对象或数组,可空
}

code为 "success"表示请求成功,其他情况都为请求失败

失败格式

{
  "code": "-500",
  "message": "订单不存在",
  "data":{} //响应数据,json对象或数组,可空
}
2024-11-13
0 0