响应请求

客户端发送的每次调用请求,无论成功与否,系统都会返回数据。根据客户端请求参数format不同响应格式也会不同,但不管何种格式,数据结构体必定一样。数据结构如下:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "app_id": 1,
  6. "app_name": "Web",
  7. "app_key": 64366417,
  8. "app_secret": "78ade47b896bccf03d770a4f8e3d2968",
  9. "status": 1
  10. }
  11. }

成功返回:

字段 含义 类型 是否返回 描述
status 状态码 number 200 200 表示成功,其他表示失败
message 消息信息 string success 成功返回 success
data 返回数据 object|array 是|否 根据业务返回的数据

失败返回:

字段 含义 类型 是否返回 描述
status 状态码 number 不同的状态码
message 消息信息 string 失败原因

备注:

  1. 本册文档中所有的返回数据结构都是针对管理组进行的,顾客组请查阅「CareyShop 客户组API 使用手册」

  2. 客户端请求 API 返回结果后,是否成功一定要从数据结构中的status字段进行判断

  3. 在接口文档中,是否返回一栏被标注为时,该字段必定返回,否则字段不返回或返回空值的字段。

  4. 返回类型为objectarray时,是否返回一栏被标注为时,那么该字段不返回或只返回字段而没有值。

  5. 防止运营商劫持请查阅「防止劫持」

文档更新时间: 2018-07-18 14:28