【自建商城】按API文档要求提供接口，【管家婆全渠道】(以下简称全渠道)主动发起请求，通过验证签名的方式来防止恶意的数据篡改。

配置自建商城 apiUrl、签名所需 appkey/appSecret

签名计算方式

消息接口

自建商城可以请求全渠道的消息接口来通知全渠道：相关数据发生了变动。全渠道接收到消息后会请求自建商城相关API获取最新数据。

消息接口调用规则、验签规则与本文一致，参数不同，具体信息详见消息接口。

业务对接流程

接口对接方式

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

参数说明

系统参数

请求所有接口均携带的参数，以 JSON 格式放在body里，用于系统身份认证和数据安全校验。系统参数包括：

参数名	类型	参数描述
appkey	string	新建自建商城类型的网店后，全渠道分配的appkey，详见准备工作
method	string	调用的API方法名称，即API文档中以open开头的字符串
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"
}

自建商城只需要开放一个接口地址，通过判断method值来执行对应的业务流程。

业务参数

业务参数是指调用具体某个接口时需要的和业务相关的参数，通常不同的接口有不同的业务参数。业务参数将统一被序列化为 JSON 字符串赋值给系统参数中的param,例如：业务请求参数中包含offset、size字段，则传入方式如下：

// 序列化前格式
{
   "offset": 0,
   "size": 1
}

// 序列化后赋值给`param`
{
  "param": "{\"offset\":0,\"size\":1}",
}

响应参数

所有接口响应均为 JSON 格式。

成功格式

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

重要

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

失败格式

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

注

自建商城接口开发者收到全渠道的接口请求后，需按照文档中的参数格式给全渠道返回信息。