中国站

产品

硅云帮助文档中心

搜索文档

热门搜索词:

通用说明

更新时间:2020-05-21 16:22  版本:v1.0
分享到:
我要反馈 
收藏 我的收藏

协议服务域名说明


支持协议: https

服务域名 : api.vpsor.cn


公共请求头说明


请求头描述
request_id请求id,作为链路追踪和密钥签名使用,由字母和数字组成不要出现需经过url编码的字符,建议使用uuid作为request_id,request_id长度为16到64位
api_key接口api_key,在官网创建,需要实名之后才能创建

signature

签名 


  签名 signature=SHA-256(requestUrl+request_id+api密钥):


  •   SHA-256:调用HMAC SHA256算法,并把结果转换为小写形式的十六进制字符串

  •   requestUrl:接口地址不含?以后的数据,如https://api.vpsor.cn/ncs-server/api/v1/host/create?test=1  requestUrl 为:  /ncs-server/api/v1/host/create

  •   request_id:  作为链路追踪和密钥签名使用,由字母和数字组成不要出现需经过url编码的字符,建议使用uuid作为request_id,request_id长度为16到64位,请不要使用固定的request_id

  •   api密钥: 和api_key对应的api_密钥,在官网生成后请不要泄漏

  •   安全性: 安全性主要由api密钥不泄露和白名单保证



例子:    requestUrl=/ncs-server/api/v1/host/create

               request_id=2942183558593ffc9d75fb8e16793ff

             api密钥=LSh9hu7pVwYYSG2ySh6NVS4z3ZTWFqLJ

               此时签名=6c3d41ac0e7439898e750c337413dbe7660ba95bcfc1dc73f3eca8a4b3328735



请求结构说明:


数据交换格式为JSON,所有request/response body内容均采用UTF-8编码。

请求参数包括如下4种:


URI通常用于指明操作实体,如:POST /ncs-server/api/v1/host/create
Query参数URL中携带的请求参数,如 GET /ncs-server/api/v1/host/get?id=1
HEADER请求头,request_id,api_key,signature 为必须携带的请求头
RequestBody通过JSON格式组织的请求数据体


返回结果说明


http 状态码: 


  • 200 : 此状态码表示接口调用成功,但结果不一定成功,看ResponseBody判断结果是否符合预期

  • 403 : 此状态码表示接口调用没有权限,请查看返回消息,检查 api_key 和 signature 是否传递有错误



ResponseBody结构:


{
    "status":2000,  //状态码,int类型,2000为成功,否则为失败,具体参考错误状态码
    "message": "success", //提示消息,string类型,
    "data":object          //返回数据,泛型,当为空时不返回
}


密码加密传输规范


所有涉及密码的接口参数都需要加密,禁止明文传输。密码一律采用AES 128位加密算法进行加密,用api密钥的前16位作为密钥,加密后生成的二进制字节流经过base64二次编码,并以字符串的形式传到服务端。具体步骤如下:

  • byte[] bCiphertext= AES128(明文,api密钥前16位)

  • String strBase64 = Base64(bCiphertext)


例子:   明文=123456

          api密钥=LSh9hu7pVwYYSG2ySh6NVS4z3ZTWFqLJ

          strBase64=FDyaCCrqZphejQDcdUP/Tg==



您对该文档有什么建议?

您对该文档的评分:

本文导航

搜索文档