微信电子健康卡开放平台接口对接

最新推荐文章于 2023-06-29 11:50:19 发布

weixin_48906544

最新推荐文章于 2023-06-29 11:50:19 发布

阅读量1w

点赞数 5

分类专栏：微信平台文章标签： java 网络

本文链接：https://blog.csdn.net/weixin_48906544/article/details/113914075

版权

微信平台专栏收录该内容

1 篇文章 0 订阅

订阅专栏

需求：

最近在做数据上传的项目，请求第三方数据上传接口时，需要调用单独的接口获取权限appToken。

接口输入参数由公共输入参数commonIn和请求参数req(第三方数据上传接口的参数)组成，输出参数由公共输出参数commonOut和响应参数rsp组成；

{
    "commonIn": {
        "appToken": "11fd722a113969bf2480fe4781fc7234",
        "requestId": "A37FA9D0D0DF432B9D367B16AEEDE77A",
        "hospitalId": "10086",
        "timestamp": "1525392000",
        "channelNum": 0,
        "sign": "Q5vp1tdaHjuQpDK8yuDOAzFKTOQs5PxgzhLbxMpnadE="
    },
    "req": {
        ......//请求参数 (上传接口的参数)
    }
}

之前看第三方文档不多，因此，在对接获取接口调用凭证appToken接口时，输入参数中sign签名不知道从哪获取，还在对接群问问腾讯开发人员，体现出自己的不专业，写篇文章记录一下对接的过程。

微信电子卡开放平台
在这里插入图片描述

开发指南

我们在第三方对接时，要先看开发指南，对平台和一些规则做初步的了解，不懂的地方标记下来，最后统一咨询平台的开发人员。

基本术语

● HTTPS：超文本传输安全协议（Hypertext Transfer Protocol Secure，常称为HTTP over SSL）是一种通过计算机网络进行安全通信的传输协议。HTTPS经由HTTP进行通信，但利用SSL/TLS来加密数据包；

● JSON：JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式；

● appId：由健康卡开放平台分配给各个ISV的用户凭证；

● appSecret：由健康卡开放平台分配给各个ISV的用户凭证密钥；

● appToken：通过appId和appSecret向健康卡开放平台换取接口调用凭证；

● wechatCode：微信身份码wechatCode唯一标识一个微信帐号，用于在开放平台建卡；

● healthCode：健康卡授权码healthCode对应一张健康卡，用户获取对应健康卡的信息。

获取接口调用凭证appToken接口

接口地址：

https://p-healthopen.tengmed.com/rest/auth/HealthCard/HealthOpenAuth/AuthObj/getAppToken

该接口用于获取接口调用凭证appToken，appToken是公共参数commonIn 参数之一，是全局唯一接口调用凭据，开发者需要进行妥善维护。

appToken的生成及使用方式说明：

通过该接口获取appToken时，appToken参数不校验，可以为空；
appToken有效期7200秒，需定时刷新，重复获取将导致上次获取的appToken失效；
建议开发者使用中控服务器统一获取和刷新appToken，其他业务逻辑服务器所使用的appToken均来自于该中控服务器，不应该各自去刷新，否则容易造成冲突，导致appToken覆盖而影响业务；
中控服务器需要根据7200秒有效时间提前获取新appToken，为了保持平滑过渡，最近刷新的两个appToken均有效，且次新appToken将在5分钟后失效；
开发时需要做好appToken缓存策略，每7200秒有效时间定时获取，期间接口调用时均使用缓存的appToken，不要每次调用接口时都重新获取；

输入参数：

请求参数req说明：

参数名称	    参数代码	 必选	 类型	             说明
ISV用户凭证	appId	  是	   string	开放平台官网分配的appId

{
    "commonIn":
    {
        "appToken": "",
        "requestId": "E856812660584E208D7421E1CAACE8C3",
        "hospitalId": "10086",
        "timestamp": "1525392000",
        "channelNum": 0,
        "sign": "Q5vp1tdaHjuQpDK8yuDOAzFKTOQs5PxgzhLbxMpnadE="
    },
    "req":
    {
        "appId": "d7656ef9ab5eb27c01724cd3707xxxxx"
    }
}

缓存：采用的map做缓存+定时任务每2个小时重新刷新一次

我们在看第三方文档时会发现，提供不同语言的实例，我想也是为了我们提供开发效率。
在这里插入图片描述

在对接时，主要是获取接口参数的签名，平台也会提供代码示例。

签名规则

开放平台会校验调用接口的签名参数sign，因此ISV需要严格按照规则生成，否则会报签名错误。

签名参数sign由公共参数commonIn+请求参数req+appSecret按照一定的规则生成。以获取接口调用凭证appToken接口为例，调用这一接口的输入参数如下所示，其中appToken、sign等为空值的参数不参与签名。

输入参数示例（无签名）：

{
	"commonIn":{
		"appToken":"",
		"requestId":"DB4D975748A84309977EA25224C0F5CF",
		"hospitalId":"90003",
		"timestamp":"1525392000",
        "channelNum": 0,
		"sign":""
	},
	"req":{
		"appId":"a1a2e0bde41574ad8ea9a4bb58022oop"
	}
}

1、对参数排序
首先需要对所有参数按参数名做字典序升序排列，上述示例参数的排序结果为：

{
     "appid":"a1a2e0bde41574ad8ea9a4bb58022oop",
     "channelNum": 0,
     "hospitalId":"90003",
     "requestId":"DB4D975748A84309977EA25224C0F5CF",
     "timestamp":"1525392000",
 }

所谓字典序升序排列，直观上就如同在字典中排列单词一样排序，按照字母表或数字表里递增顺序的排列次序，即先考虑第一个“字母”，在相同的情况下考虑第二个“字母”，依此类推。

注意：批量注册健康卡接口中，请求参数含有嵌套的JSON字段，也需要按参数名做进行字典序升序排列。

2、拼接签名原文

将上一步排序好的请求参数格式转化成参数名称=参数值的形式，如其参数名称为appId，参数值为a1a2e0bde41574ad8ea9a4bb58022oop，因此格式化后就为appId=a1a2e0bde41574ad8ea9a4bb58022oop。

将上述示例参数拼接后的签名原文为：

appId=a1a2e0bde41574ad8ea9a4bb58022oop&channelNum=0&hospitalId=90003&requestId=DB4D975748A84309977EA25224C0F5CF&timestamp=1525392000

3、生成签名串
将上一步中获得的签名原文与appSecret进行字符串拼接，即：签名原文+appSecret，然后使用 SHA256算法对其加密，将生成的签名串（字节数组）使用 Base64 编码，即可获得最终的签名串。

伪代码如下：

签名原文 = "appId=a1a2e0bde41574ad8ea9a4bb58022oop&channelNum=0&hospitalId=90003&requestId=DB4D975748A84309977EA25224C0F5CF&timestamp=1525392000"
签名 = Base64(SHA256("appId=a1a2e0bde41574ad8ea9a4bb58022oop&channelNum=0&hospitalId=90003&requestId=DB4D975748A84309977EA25224C0F5CF&timestamp=15253920008c8e763f443ef983ac33aef1c7085cfb"))

最终得到的签名串为：

Ar2jTk5vw7iiGkHFLcWfsUrekRoFrTCMXPJg92b32n4=

4、生成最终的输入参数
将上一步获取的签名串放入**获取接口调用凭证appToken输入参数（无签名）**中，最终结果如下：

{
	"commonIn":{
		"appToken":"",
		"requestId":"DB4D975748A84309977EA25224C0F5CF",
		"hospitalId":"90003",
		"timestamp":"1525392000",
        "channelNum": 0,
		"sign":"Ar2jTk5vw7iiGkHFLcWfsUrekRoFrTCMXPJg92b32n4="
	},
	"req":{
		"appId":"a1a2e0bde41574ad8ea9a4bb58022oop"
	}
}

使用最终的输入参数调用开放平台的获取接口调用凭证appToken接口即可。

JAVA签名DEMO代码示例：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.serializer.SerializerFeature;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.security.MessageDigest;
import java.util.*;

public class SignDemo {

    public static void main(String[] args) {
        
        //appSecret
        String appSecret = "8c8e763f443ef983ac33aef1c7085cfb";

        // 示例：获取接口调用凭证appToken接口的完整请求参数如下
        String reqParams = "{" +
                "    \"commonIn\":{" +
                "        \"appToken\":\"\"," +
                "        \"requestId\":\"DB4D975748A84309977EA25224C0F5CF\"," +
                "        \"hospitalId\":\"90003\"," +
                "        \"timestamp\":\"1525392000\"," +
                "        \"sign\":\"\"" +
                "    }," +
                "    \"req\":{" +
                "        \"appId\":\"a1a2e0bde41574ad8ea9a4bb58022oop\"" +
                "    }" +
                "}";

         //构造当前时间戳
        long time = System.currentTimeMillis();
        String nowTimeStamp = String.valueOf(time / 1000);
        
        //构造requestId
        String requestId = UUID.randomUUID().toString().replaceAll("-", "");
               
        JSONObject jsonObject = JSON.parseObject(reqParams);

        Map<String, Object> commonIn = jsonObject.getJSONObject("commonIn");
        //commonIn.put("timestamp", nowTimeStamp);
        //commonIn.put("requestId", requestId.toUpperCase());
        Map<String, Object> req = jsonObject.getJSONObject("req");
        
        // 生成原始签名串
        SortedMap<String, Object> treeMap = new TreeMap<>();
        treeMap.putAll(commonIn);
        treeMap.putAll(req);
        String rawStr=getParamsFromMap(treeMap);
        
        // 生成签名
        String sign = generateSign(rawStr, appSecret);
        System.out.println(sign);
    }

    /**
     * 对请求参数进行排序拼接(含嵌套的JSON字符串)，生成待签名字符串
     *
     * @param map
     * @return
     */
    private static String getParamsFromMap(SortedMap<String, Object> map) {
        // sign不参与签名
        map.remove("sign");
        StringBuilder sb = new StringBuilder();
        Set es = map.entrySet();
        Iterator it = es.iterator();
        while (it.hasNext()) {
            Map.Entry entry = (Map.Entry) it.next();
            String k = entry.getKey().toString();
            Object objVal = entry.getValue();
            if (objVal == null) { //值为空的参数不参与签名
                continue;
            }
            String v;
            if (isBaseDataType(objVal.getClass())) {
                v = objVal.toString();
            } else {
                v = JSON.toJSONString(objVal, SerializerFeature.MapSortField);
            }
            if (!v.equals("")) {
                if (it.hasNext()) {
                    sb.append(k).append("=").append(v).append("&");
                } else {
                    sb.append(k).append("=").append(v);
                }
            }
        }
        return sb.toString();
    }

    private static boolean isBaseDataType(Class clazz) {
        return (clazz.equals(String.class) || clazz.equals(Integer.class) || clazz.equals(Byte.class)
                || clazz.equals(Long.class) || clazz.equals(Double.class) || clazz.equals(Float.class)
                || clazz.equals(Character.class) || clazz.equals(Short.class) || clazz.equals(BigDecimal.class)
                || clazz.equals(BigInteger.class) || clazz.equals(Boolean.class) || clazz.equals(Date.class) || clazz
                .isPrimitive());
    }

    /**
     * Base64(sha256(rawStr + appSecret))进行签名
     * @param rawStr     原始字符串
     * @param appSecret  密钥
     */
    private static String generateSign(String rawStr, String appSecret) {
        try {
            // 先用sha256加密
            MessageDigest sha256 = MessageDigest.getInstance("SHA-256");
            sha256.update((rawStr + appSecret).getBytes("utf-8"));

            // 再用base64编码
            return Base64.getEncoder().encodeToString(sha256.digest());
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

总结：

其实对接下来并不难，刚开始想着接口签名加密比较困难，但是对接完之后，再回头看走过的弯路是可以规避的，不用再问对方很多问题，以后再对接类似的项目先看文档，通读3遍第三方接口文档，不懂的问题再问。
在这里插入图片描述

weixin_48906544

关注

5
点赞
踩
12

收藏

觉得还不错? 一键收藏
2
评论
微信电子健康卡开放平台接口对接

需求：最近在做数据上传的项目，请求第三方数据上传接口时，需要调用单独的接口获取权限appToken。接口输入参数由公共输入参数commonIn和请求参数req(第三方数据上传接口的参数)组成，输出参数由公共输出参数commonOut和响应参数rsp组成；{ "commonIn": { "appToken": "11fd722a113969bf2480fe4781fc7234", "requestId": "A37FA9D0D0DF432B9D367B16AEED
复制链接

扫一扫