纪检监察信息化监督平台数据接口请求格式、响应状态码、认证与鉴权流程示例.docxVIP

（资料性）接口请求格式 接口请求格式 接口请求格式示例见表A.1。 接口请求格式示例 请求URL https://ip:port/服务名称 请求方法 GET 请求参数 是否必传 数据类型 说明 page 否 数字型 页码 size 否 数字型 分页大小 *** 否 根据具体情况确定 业务参数 返回参数 参数名 是否必传 数据类型 说明 code 是 数字型 状态码(200 表示请求正常，其它值异常) message 否 字符型(n) 消息提示，n 为消息长度，其取值根据具体情况确定 data 否 根据具体情况确定 接口的主数据，即业务数据。可以根据实际返回数组或者特定格式数据对象（如 JSON 格式等） total 否 数字型 记录总数，列表查询返回 page 否 数字型 当前页，列表查询返回 size 否 数字型 分页大小，列表查询返回 pages 否 数字型 总页数，列表查询返回 POST接口请求格式 POST接口请求格式示例见表A.2。 POST接口请求格式示例 请求URL https://ip:port/服务名称 请求方法 POST 请求参数 是否必传 数据类型 说明 name 否 字符型 名字 sex 否 数字型 性别 0 表示男 1表示女 age 否 数字型 年龄 请求参数JSON示例 { name: 张某某, sex: 1, age: 30 } 返回参数 参数名 是否必传 数据类型 说明 code 是 数字型 状态码(200 表示请求正常，其它值异常) message 否 字符型(n) 消息提示，n 为消息长度，其取值根据具体情况确定 （规范性）接口响应状态码 状态码的定义遵循RFC 2616规范，常见HTTP响应状态码及其含义如表B.1： 接口返回状态码 状态码 含义 200 请求已成功 400 请求信息不完整或无法解析 401 访问令牌没有提供，或者无效 403 访问令牌有效，但没有权限 404 资源不存在 409 资源冲突 422 请求信息完整，但无效 500 服务器内部抛出错误 （资料性）认证与鉴权流程示例 身份认证 概述 数据获取方根据已有账号信息创建安全会话并获取secretKey。 请求示例 POST请求：https://ip:port/api/v{n}/auth/login Content-Type: application/json 请求参数： { pwd: pwd, username: username } 返回结果 { msg: 登录成功, code: 200, token: secretKey值“ } 访问控制 概述 数据获取方向数据提供方申请服务接口调用授权通过后获取到授权码AuthorizationCode。 数据获取方根据获取到的secretKey 和AuthorizationCode 填写至http 请求头中 调用接口，请求参数、方法、格式以接口详情中的描述为准。 请求示例 GET请求： https://ip:port/api/v{n}/resource/get_list header：secretKey=”secretKey” AuthorizationCode =”AuthorizationCode ” 返回结果 正常返回结果 { code:200, message:数据获取成功, data:[ { user_id:1, age:20, user_name: 张三, sex: 男, create_user: lisi, create_time: 2019-03-01 16:00:00, update_user:null, update_time: null, remark:null } { user_id:2, age:23, user_name:李四, sex: 女, create_user:lisi, create_time: 2019-03-01 16:00:00, update_user:null, update_time: null, remark:null } { user_id:3, age:22, user_name:王五, sex: 男, create_user:lisi, create_time: 2019-03-01 16:00:00, update_user:null, update_time: null, remark:null } ], total:5, page:1, size：3, pages:2 } 异常返回结果 { code:401, message:用