贝蒙科技(深圳)有限公司SHOPTIMA平台第三方接口文档 v1.0.0

1 规范说明

1.1 通信协议

HTTPS协议

1.2 请求方法

GET:通常用于获取信息

POST:通常用于新增或者修改数据

PATCH:通常用于修改数据

DELETE:通常用于删除数据

1.3 请求域名

接口请求域名:open.shoptima.shop

公共域名路由: /api/v1(版本后)

例如:

GET https://open.shoptima.shop/api/v1/order

1.4 请求验证

接口遵循OAuth2简化模式,通过appKeyappSecret获取永久授权的token

在request请求头的authorization属性中传入bearer token通过验证

具体获取token方法,详情请见token接口相关章节

1.5 request 请求

1.5.1 参数说明 RequestData(请求内容): 其明文为每次请求的具体参数,采用 JSON 格式,依次经过 DES 加密(以UTF-8编码、BASE64编码输出结果)和 URLEncode 后,作为 RequestData 的值。

1.5.2 请求内容(RequestData)明文结构说明 采用JSON格式,其中包含Header(公有参数)、Body(私有参数)节点:

名称 描述 备注 公共参数 每个接口都包含的通用参数,以JSON格式存放在Header属性 私有参数 每个接口特有的参数,以JSON格式存放在Body属性 详见每个接口定义

1.6 response 返回值

status 状态值 code 状态码 message 提示消息 data 返回数据

请求成功事例:

{
    "status": "success",
    "code": 200,
    "message": "",
    "data": {
    }
}

请求失败事例:

{
    "status": "error",
    "code": 401,
    "message": "token格式错误"
}