基础文档

新手指南

概述

本文档提供对外服务的接口文档和说明，从业务上分为WEB和API两部分。

产品介绍

对密码设备进行管理，使密码设备的密钥最大化利用

基础概念解释

1、公共参数: 公共请求参数是指每个接口都需要使用到的请求参数，与业务无关;

2、业务参数: 根据调用API服务接口的需求所传递的参数;

3、表单: 在网页中主要负责数据采集功能。一个表单有三个基本组成部分：表单标签：这里面包含了处理表单数据所用CGI程序的URL以及数据提交到服务器的方法。表单域：包含了文本框、密码框、隐藏域、多行文本框、复选框、单选框、下拉选择框和文件上传框等。表单按钮：包括提交按钮、复位按钮和一般按钮；用于将数据传送到服务器上的CGI脚本或者取消输入，还可以用表单按钮来控制其他定义了处理脚本的处理工作。

API 调用协议

接口支持 HTTP，HTTPS GET/POST 请求，所有接口需在请求中加入公共参数，请求及返回结果都使用 UTF-8 字符集进行编码。

组装 HTTP(S) 请求

将所有参数名和参数值采用 UTF-8 进行 URL 编码（参数顺序可随意，但必须要包括签名参数），然后通过GET或POST发起请求

注意事项

1、所有的请求和响应数据编码皆为 UTF-8 格式，URL 里的所有参数名和参数值请做 URL 编码。如果请求的 Content-Type 是 application/x-www-form-urlencoded，则 HTTP Body 体里的所有参数值也做 URL 编码；如果是 multipart/form-data 格式，每个表单字段的参数值无需编码, 但每个表单字段的 charset 部分需要指定为 UTF-8。

2、参数名与参数值拼装起来的 URL 长度小于 1024 个字符时，可以用 GET 发起请求；参数类型含 byte[] 类型或拼装好的请求 URL 过长时，必须用 POST 发起请求。所有 API 都可以用 POST 发起请求。

公共参数

公共请求参数是指每个接口都需要使用到的请求参数

名称	类型	是否必须	描述
Authorization	String	是	身份标识,置于http请求头(Request Headers)中，用户登录后获得该值(由于App端的用户维护(注册、登录等)不在云证书系统中，所以App端接口调用不需要设置此参数，但相关需要确定用户身份的接口需要传参userTag，详情关注APP的具体接口说明)。

请求示例：

curl -X GET "http://222.190.151.234:23010/bizadmin/ca/cloud/sign/biz/web/data/get/request-id" -H "accept: */*" -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiLpgrXkvKDms6IiLCJ1c2VySWQiOiJBRE1JMjAxODA0MTIwMDAwMDAxIiwibmFtZSI6IjE4MTU1NTU1NTU1IiwidXNlclR5cGUiOiJhZG1pbiIsImV4cGlyZSI6MTU1ODQ5NzAzMTI3NywiZXh0ZW5kSW5mb3MiOnsic2lnbklkIjoiQURDTTIwMTgwNDEyMDAwMDAwMSJ9fQ.FibRsYog-PgWDqbhzj0kxw5-4UtizMdZPvZ7XNTCgSNE19MIZ-QSY2oPxTrvoDv-c-hcnRHTuGuvmP8lo_uF0BT82RcG-veCmaQigRgi0convE73XwUcCEBAy-La8Qg_Wj6C8bhbO_FB8czWYwALCSMKkQ9nIG3b6xfW10T_Tts"

响应参数

调用 API 服务后返回数据采用统一格式，code 为 0 ，请求成功，其他为失败，这时没有 data 结果信息

名称	类型	描述
code	Integer	状态码，0 请求成功，其他为失败
message	String	状态码的描述
data	Object	code 为 0 时出现，结果信息,具体看各个接口说明

成功示例

JSON示例

{
  "code": 0,
  "message": "success",
  "data": {XXX}
}

失败示例

JSON示例

{
  "code": 91008,
  "message": "用户身份信息错误"
}