# 网关接入标准

# 版本记录

时间 描述
2019-4-16 简化授权流程
2019-4-21 补充腾讯调用合作方签名算法

# 合作方请求腾讯

# 综述

  1. 采用HTTPS传输数据
  2. 采用POST方法提交数据,请求和响应都是JSON
  3. 腾讯会为每个发卡行提供: partnerIdpartnerSecret,请单独联系腾讯工程师获取
  4. 字符编码统一采用UTF-8
  5. 接口都要在服务器端调用,切不可把partnerSecret下发给前端。

# 调用URL

测试环境调用URL为https://med-biz-pre.wecity.qq.com/api/$app/$func/$partnerId

正式环境调用URL为https://med-biz.wecity.qq.com/api/$app/$func/$partnerId

URL中的$app替换为应用名,如果没有明确指出,默认为VipHosp$func替换为具体接口名称,$partnerId为腾讯为发卡行分配的唯一标识。

# 权限验证

以下参数需要放在每次请求的header中

变量名 描述
god-portal-timestamp 当前的时间戳,单位:毫秒
god-portal-signature HMAC-SHA256(partnerSecret, partnerId + timestamp)

# 响应报文结构

响应的HTTP状态码如果不是200,说明发生系统级的错误。响应的状态码是200时,会保证报文结构会统一成下面的结构,方便做错误判断。

变量名 描述 类型 备注
code 错误码 int 0表示正常 ; 小于 表示腾讯服务出错; 大于0表示业务上出错
message 错误说明 string
rsp 业务数据 object 具体结构由各接口定义

# 参考例子

假设医疗机构的身份信息如下

名称 内容
partner id 10000001
partner secret b06c75b58d1701ff470119a4114f8b45

完整的请求样例。请求:

POST /api/VipHosp/getInfo/10000001 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: med-biz-pre.wecity.qq.com
god-portal-signature: 90ecc950a570d3ae79291fc3a96175e476a39dbcb9c370ed7bb81787fbc9f2f0
god-portal-timestamp: 1529853639000
  
{
    "key": "value"
}

响应:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
god-portal-request-id: 935108d0-742a-11e8-8039-19ae4b432bf3

{
    "code": 0,
    "message": "",
    "rsp": {
        "key": "value"
    }
}

# 腾讯请求合作方

# 综述

  1. 采用POST方法提交数据,请求和响应都是JSON
  2. 腾讯为合作方分配partnerIdpartnerSecret
  3. 字符编码统一采用UTF-8

# 权限验证

以下参数需要放在每次请求的header中

变量名 描述
god-portal-partner-id partnerId
god-portal-timestamp 当前的时间戳,单位:毫秒
god-portal-signature HMAC-SHA256(partnerSecret, partnerId + timestamp)

# 响应报文结构

响应的HTTP状态码如果不是200,说明发生系统级的错误。响应的状态码是200时,会保证报文结构会统一成下面的结构,方便做错误判断。

变量名 描述 类型 备注
code 错误码 int 0表示正常 ; 小于 表示腾讯服务出错; 大于0表示业务上出错
message 错误说明 string
rsp 业务数据 object 具体结构由各接口定义

# 参考例子

假设腾讯的身份信息如下

名称 内容
partner id 10000001
partner secret b06c75b58d1701ff470119a4114f8b45

完整的请求样例。请求:

POST /custom-url HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: med-biz-pre.wecity.qq.com
god-portal-partner-id: 10000001
god-portal-signature: 90ecc950a570d3ae79291fc3a96175e476a39dbcb9c370ed7bb81787fbc9f2f0
god-portal-timestamp: 1529853639000

{
    "key": "value"
}

响应:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
request-id: 935108d0-742a-11e8-8039-19ae4b432bf3

{
    "code": 0,
    "message": "",
    "rsp": {
        "key": "value"
    }
}