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

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

  1. 1、本文档共6页,可阅读全部内容。
  2. 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
  3. 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载
  4. 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
  5. 5、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
  6. 6、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们
  7. 7、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
  8. 8、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
(资料性) 接口请求格式 接口请求格式 接口请求格式示例见表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:用

您可能关注的文档

文档评论(0)

雄霸天下 + 关注
实名认证
文档贡献者

该用户很懒,什么也没介绍

1亿VIP精品文档

相关文档