OpenApi 签名生成工具使用说明
一、背景描述
现场项目进行OpenAPI对接的时候,很多第三方都会用postman 来验证我们的接口是否正常,但是我们的接口调用需要签名认证,第三方会因为无法生成签名而无法正常调用我们的接口。为了解决这个问题,特此编写该工具,一方面可以生成签名,方便第三方通过postman 测试;一方面展示签名的生成规则以及接口调用方式,使第三方对接口调用认证更加容易理解。
二、软件说明
依赖 4.5 环境;
三、使用方法
1.运行程序
2. 参数说明
Method :HTTP 请求方法 GET/POST ;
请求头(Headers)包括 Accept ,Content-MD5,Content-Type ,Date ,X-Ca-Key ,X-Ca-Timestamp ,X-Ca-Nonce ,X-Ca-Signature ,X-Ca-Signature-Headers 等 ∙
Accept :默认值为*/*。 ∙ Content-MD5 设置值:MD5 计算 body 的信息摘要,对信息摘要使用 BASE64 生成 Conten-MD5 字
app接口测试工具符串,示例:encoderBase64(Bytes(“UTF -8”)))//其中 body 就是请求调用接口时的 json 参数;允许为空。
∙ Content-Type :默认值为 application/json
∙ Date :当前时间,格式不做要求;允许为空。
∙ X-Ca-Key :appKey ,即 AK 。
∙ X-Ca-Timestamp :当前时间对应的时间戳;允许为空。
∙
X-Ca-Nonce : UUID ,结合时间戳防重复;允许为空。 ∙ X-Ca-Signature :签名,以 appSecret (即 SK )为密钥,使用 HmacSHA256 算法对签名字符
串生成消息摘要,对消息摘要使用 BASE64 算法生成签名(签名过程中的编码方式全为 UTF-
8),公式如下:X-Ca-Signature=BASE64(HmacSHA256(appSecret ,"UTF-8"(httpHeaders + customHeaders + url));
∙
X-Ca-Signature-Headers :参与签名计算的 header (请求头)的 key 值(转换为小写字母,多个 key 值按照字典排序,以英文逗号分隔,例如:x-ca-key,x-ca-nonce,x-ca-timestamp)。
接口地址:具体接口的相对地址(接口说明中的接口地址在调用前需要加上/artemis 的上下文);
HmacSHA256 加密(生成签名):以 Secret(即 SK)为密钥,使用 HmacSHA256 算法对签名字符串生成签名。签名字符串由 httpHeaders(指 http 标准 header)、customHeaders(指自
定义 header)、url 组成。各种语言 HmacSHA256 算法可以参
考如下博客说明:wwwblogs/love-snow/articles/8241314.html
3.效果展示
以下以查询组织列表的接口(/api/resource/v1/org/advance/orgList)为例展示下具体效果,根据需求勾选需要传入的请求头信息,生成签名,把工具中勾选上的请求头信息复制到 PostMan 中,传入对应的头信息,填写 Body 内容,发送请求,验证接口。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论