1.1请求和相应说明

API地址:http://hostname/openapi/cellphone/api

注意事项:

  • 数据格式:json
1
2
3
4
5
6
$post_data = array(
'method' => 'member.coupon.getlist',//调用接口的指定方法
...
'api_version'=>'1.0',
);
$post_data['sign'] =’D683FABE4C35BDA34E98C8081A683ADB‘;
  • 支持POST或GET,推荐POST

1.2参数说明

应用参数 :根据具体的API设置其参数

共通参数说明:

名称 类型 是否必须 描述
pagelimit int N 每页数据条数。如果没有该参数,则默认为10条。
nPage int N 取得数据第几页,如果没有该参数,则默认为第1页。

API接口名称说明:member.coupon.getlist

member.coupon:Service ID

getlist: action

返回值 :

名称 类型 是否必须 描述
success boolean Y true:调用成功数据有效 false:调用失败或数据无效
msg string Y 错误消息或说明
result string Y 调用成功后返回的数据

1.3签名和加密

1.3.1生成步骤

  1. 根据参数名称(系统参数和应用参数)将所要传递的参数(签名除外)按照参数名做升序排序,然后对参数名和参数值(使用UTF-8编码)链接成字符串。
  2. 将此字符串加上中心会话密钥token进行一次MD5,获得十六进制字符串,转成大写格式。
  3. 将一次MD5后的字符串再次MD5,获得十六进制字符串,转成大写格式。
  4. 最后把结果当做一个请求参数,名称为sign。
  • 举例:
    1. 请求参数为:brand_id=1、type_id=3、type_name=中文,token为:adj126fukgf773ljf2a3si。
    2. 步骤1后的字符串为:brand_id1type_id3type_name中文
    3. 步骤2后的字符串为:0517312AEA74AF7AA05856880070160A
    4. 步骤3后的字符串为:E64EA87770310C0F364CC82B3FA134D2
      5.步骤三:sign=E64EA87770310C0F364CC82B3FA134D2

中心会话密钥:token(事先给到)

目前采用:base_certificate::gen_sign($postdata)

2.接口列表

接口描述 接口名 备注
商品列表 goods.search.getlist 取得商品列表
退出账号 member.logout 会员退出登录
在线客服一览 custom.member.getlist 获取当前在线客服一览
链接客服 custom.member.call 和在线客服链接后打开交流窗口
客服留言表示 custom.commnet.detail 客服留言内容表示
客服留言 custom.commnet.save 客服留言保存
客服对话表示 custom.dialog.detail 客服对话内容表示
客服对话 custom.dialog.send 客服对话内容表示

3.接口说明

3.1商品列表

  • 接口名:goods.search.getlist

  • 中文名:商品搜索

  • 参数:

    • 结构说明
字段 数据类型 是否必须 备注
session string N
pagelimit int N 每页显示商品数(如果没有该参数默认是4个商品)
nPage int N 当前页(默认第一页)
show_count int N 显示商品件数(没有该参数默认显示全部)
cat_type int N 商品检索分类 1=>普通商品 默认 2=>热销商品 3=>新品推荐 4=>促销商品 5=>新品测试 6=>新品赠送 7=>新品广告 8=>滞销产品 9=>二手商品 10=>租赁商品 11=>商品推荐 12=>促销商品 13=>商品推广 14=>限时抢购 15=>秒杀商品 16=>团购商品 17=>拍卖商品 18=>销售选型
key string N 搜索关键字
orderby int N 排序: 1=>默认 2=>按发布时间 新->旧 3=>按发布时间 旧->新 4=>按价格 从高到低 5=>按价格 从低到高 6=>评论次数 从高到低 7=>评论次数 从低到高 8=>总访问次数 从高到低 9=>总访问次数 从低到高 10=>总购买次数 从高到低 11=>总购买次数 从低到高 12=>月购买次数 从高到低 13=>月购买次数 从低到高
picSize string N 图片大小: CS:小图。 CL:大图。 默认:CS
region string N 区域:逗号分隔的三级区域ID
store_cat string N 品类:逗号分隔的三级品类ID
act_id string N 所属活动ID
recommend_id int N 推荐分类ID
  • 返回结果

    • 数据结构
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    {
    "success": true,
    "msg": "",
    "result": {
    "store_count": "500",
    "data": [
    {
    "goods_id": "001",
    "name": "十字螺丝刀",
    "introduce": "十字螺丝刀",
    "price": 5.5,
    "mktprice": 8,
    "preprice": 5.5,
    "store_id": "WuJin_1",
    "store_name": "五金一店",
    "image": "LuoSiDao_ShiZi,jpg",
    "storenumber": 100,
    "salenumber": 20,
    "personlimit": 3,
    "qq": "1234567",
    "phone": "18912345678",
    "favorite": "true"
    },
    {
    "goods_id": "002",
    "name": "一字螺丝刀",
    "introduce": "一字螺丝刀",
    "price": 5.5,
    "mktprice": 8,
    "preprice": 5.5,
    "store_id": "WuJin_1",
    "store_name": "五金一店",
    "image": "LuoSiDao_YiZi,jpg",
    "storenumber": 80,
    "salenumber": 10,
    "personlimit": 3,
    "qq": "1234567",
    "phone": "18912345678",
    "favorite": "false"
    }
    ]
    },
    "session": "7311da98bd0f18eb15a96bcb263f4153"
    }
    • 结构说明
字段 数据类型 备注
page array 分页信息
limit int 每页显示数量
tPage int 总页数
cPage int 当前页
count int 商品总数量
store_count int 店铺总数量
data array 商品信息
goods_id string 商品ID
name string 商品名
introduce string 商品介绍
price float 销售价
mktprice float 市场价
preprice float 优惠价
store_id int 店铺ID
store_name string 店铺名
image sting 商品图片,为空则没有图片。
storenumber int 商品库存数量
salenumber int 商品销售数量
personlimit int 商品限购数量
qq string 联系QQ
phone string 联系电话
popularity int 人气
favorite boolean 是否收藏

3.2退出账号

  • 接口名:member.logout

  • 参数:

    • 结构说明
字段 数据类型 是否必须 备注
session string Y
  • 返回结果

    • 数据结构
    1
    2
    3
    4
    5
    6
    7
    {
    "success": true,
    "msg": "退出登录成功",
    "result": null,
    "process_time": "200",
    "session": "7311da98bd0f18eb15a96bcb263f4153"
    }
    • 结构说明
字段 数据类型 备注
process_time string 经过时长

3.3在线客服一览

  • 接口名:custom.member.getlist

  • 参数:

    • 结构说明
字段 数据类型 是否必须 备注
session string N
  • 返回结果

    数据结构:NA

    结构说明

字段 数据类型 备注
custom array 在线客服
id string 客服ID
name string 客服名称
status int 状态 1:在线 0:离线

3.4链接客服

  • 接口名:custom.member.call

  • 参数:

    • 结构说明
字段 数据类型 是否必须 备注
session string N
custom_id string Y 客服ID
status int Y 客服状态 1:在线 0:离线
member_id string Y 客户ID 当未登录时使用游客身份
  • 返回结果
    • 数据结构:NA
    • 结构说明:NA

      3.5客服留言表示

  • 接口名:custom.commnet.detail
  • 参数:
    • 结构说明
字段 数据类型 是否必须 备注
session string N
custom_id string Y 客服ID
  • 返回结果

    • 数据结构:NA

    • 结构说明

字段 数据类型 备注
custom_id string 客服ID
custom_name string 客服名称
status int 状态 1:在线 0:离线

3.6客服留言保存

  • 接口名:custom.commnet.save
  • 参数:
    • 结构说明
字段 数据类型 是否必须 备注
session string N
custom_id string Y 客服ID
name string Y 留言者名称
data string N 留言内容
  • 返回结果
    • 数据结构:NA
    • 结构说明:NA

3.7客服对话

  • 接口名:custom.dialog.detail
  • 参数:

    结构说明

字段 数据类型 是否必须 备注
session string N
custom_id string Y 客服ID
member_id string Y 客户ID
  • 返回结果

    数据结构:NA

    结构说明:

字段 数据类型 备注
custom_id string 客服ID
custom_name string 客服名称
status int 客服状态 1:在线 0:离线
member_id string 客户ID
member_name string 客户名称
store_id string 店主ID
store_name string 店主名称
message array 对话记录
id string 对话ID
time string 对话时间
speaker_kind int 发言者类型 1:自己 2:对方
speaker_name string 发言者名称

3.8客服对话

  • 接口名:custom.dialog.send
  • 中文名:商品搜索
  • 参数:

    结构说明

字段 数据类型 是否必须 备注
session string N
custom_id string Y 客服ID
member_id string Y 客户ID
data string N 对话内容
  • 返回结果

    数据结构:NA

    结构说明:NA