协议约定

  1. 请求方式

本文档所定义接口基于HTTP/HTTPS协议进行传输。协议遵循Restful API接口规范。例如:查询请求使用 Get 方法,提交请求使用 Post 方法。如果一个请求不是相应的 HTTP 方法,将返回错误。
如无特殊说明,调用参数值应转码为:UTF-8, URL编码 。

  1. 接口地址
  1. HTTP请求头部

访问Restful API接口需要在请求头增加token值,以此校验访问者是否有权访问该接口。token值是通过获取授权接口获得。
请求头格式如下:

Content-Type: application/json
Authorization: Bearer ${token值}
  1. Token值的生命周期
    Token值有效期为7天, token过期前可调用刷新token有效时间。

  2. 响应

成功响应,携带的公共参数

参数名 类型 必填 描述 限制
tenantId string 租户名称
createdBy string 创建者
updatedBy string 更新者
deletedBy string 删除者
createdTime string 创建时间
updatedTime string 更新时间
deletedTime string 删除时间
isDeleted boolean 是否删除