公共参数

概述

公共参数是用于接口鉴权目的的参数，如非必要，在每个接口单独的接口文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求。
API 采用 TX 的 TC3-HMAC-SHA256 签名方法，公共参数需要统一放到 HTTP Header 请求头部中。

参数名称	参数类型	必选	参数描述
Authentication	String	是	应用鉴权的客户端令牌，此参数不参与签名计算, 生成方式参考客户端令牌生成
X-Isp-Code	String	是	此参数参与签名计算，企业码，获取路径：领效星云管理页面-> 我的企业 -> 企业ID
X-Isp-TraceId	String	是	此参数参与签名计算，traceId, 随机生成的32位uuid，如 6535e167cdf94562bb88ccdae57ea18d
X-Auth-Timestamp	String	是	此参数参与签名计算，请求发送时的时间戳（毫秒），可记录发起 API 请求的时间，注意：如果与服务器时间相差超过5分钟，会引起签名过期错误。
X-Auth-Sign	String	是	放置由下面的签名方法产生的签名。注意：本参数不参与计算签名，签名调试工具：https://api.maxhub.com/sign

注意：
构造请求头，需注意自定义字段名的大小写。签名验证以及服务器端读取字段值对大小写敏感。

生成签名串

注意：
此处为伪代码，拷贝粘贴不保证可编译运行。

String stringToSign=
HTTPMethod + "\n" + //POST, GET, PUT, DELETE
Headers + "\n" + //指定的Header参数, X-Auth-Timestamp, X-Isp-Code, X-Isp-TraceId
URI + "\n" + //eg: https://api.maxhub.com/meeting/api/client/test, URI=/meeting/meeting/api/client/test
Params       //Body中JSON序列化后的参数，GET方法没有请求体，Body需要带空串""参与计算

Header 参与签名的字段包含: X-Isp-TraceID, X-Auth-Timestamp，X-Isp-Code。
组成 Header 签名串时，参与签名的参数按参数名做字典序升序排列。注意：X-Auth-Sign 为计算后的签名字段，不参与签名计算。

标准的 HTTP Header 非空参数本手册约定不参与签名计算。
如果是带有查询参数的请求，URI 含所有的查询串，例如查询会议请求：

GET https://api.maxhub.com/meeting/api/open/v5/meetings?meetingNo=12381023
URI为"/meeting/api/open/v5/meetings?meetingNo=12381023"

例如，创建成员的HTTP POST请求示例：

POST https://api.maxhub.com/maxhub-blu/api/open/v5/member
Authorization: Bearer c7531045-7466-4262-b4d6-95b33c84e3e6
X-Isp-Code: 000001
X-Isp-TraceId: d053104574664262b4d695b33c84e3e68
X-Auth-Timestamp: 1735114681000
{
    "memberNo": "1212",
    "teamId": 0,
    "jobTitle": "经理",
    "mobile": "15622233223",
    "memberName": "张三",
    "externalId": "test1234",
    "cardNo": "952731",
    "email": "test3@qq.com"
}

步骤1：串联 Header 参数。

headerString = "X-Auth-Timestamp=" + 1735114681000 + "&X-Isp-Code=" + 000001 + "&X-Isp-TraceId=" + "d053104574664262b4d695b33c84e3e68"

步骤2：组签名串。

stringToSign = 
POST + "\n" +
headerString + "\n" +
"/maxhub-blu/api/open/v5/member" + "\n" +
"{
    "memberNo": "1212",
    "teamId": 0,
    "jobTitle": "经理",
    "mobile": "15622233223",
    "memberName": "张三",
    "externalId": "test1234",
    "cardNo": "952731",
    "email": "test3@qq.com"
}"

计算签名

拼接好待签名的字符串后，用 SecretKey 密钥生成待签名字符串的 Hmac-SHA256 签名，将签名转换为16进制字符串形式，然后进行 Base64 编码。

传递签名

对每一个 HTTP 请求，都需要将签名放到 Request 的 Header 参数 X-Auth-Sign 中去。

代码示例

说明：
如果是 GET 方法的 API 调用，例如：用会议码查询会议详情，则无请求体，签名计算时需要带入空（""）的请求体。

鉴权错误返回参数

鉴权错误返回统一为401。

公共参数

概述#

公共参数#

生成签名串#

计算签名#

传递签名#

代码示例#

鉴权错误返回参数#

概述

公共参数

生成签名串

计算签名

传递签名

代码示例

鉴权错误返回参数