用户认证
用户认证API用于验证许可证有效性,并获取小阳心健康测量服务令牌(AccessToken
)以用于初始化 SDK 供后续测量。
IMPORTANT
为防止 SDK 许可证信息泄露,建议 Web SDK 用户将许可证认证操作部署在自身应用服务端,根据自身业务需要(如限制仅付费用户可访问)进行鉴权操作。
TIP
用户认证 API 请求已默认集成在 Android / iOS SDK 当中。
请求语法
http
POST HTTP/1.1
URL: https://measurement-auth.xymind.cn/connect/sdk/token
1
2
2
请求头
名称 | 类型 | 必需 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | 字符串 | 是 | application/x-www-form-urlencoded | |
Accept-Language | 字符串 | 否 | zh-Hans |
请求参数
名称 | 类型 | 必需 | 示例值(勿用,仅作示例) | 描述 |
---|---|---|---|---|
appId | 字符串 | 是 | 3a0e6cb1f0dfc6ff708caf8dea9f6c24 | APP_ID 从管理控制台获取 |
sdkKey | 字符串 | 是 | 3a0e6cb1f0df0536d05625809aaa2329 | SDK_KEY 从管理控制台获取 |
响应头
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Content-Type | 字符串 | application/json | 内容类型 |
charset | 字符串 | UTF-8 | 内容编码 |
响应元素
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
access_token | 字符串 | 小阳心健康测量服务令牌 | |
expires_in | 字符串 | 31536000 | 过期时间 |
token_type | 字符串 | Bearer | 令牌类型 |
refresh_token | 字符串 | 刷新令牌 |
示例
- 认证成功
请求示例
http
POST /auth/connect/sdk/token HTTP/1.1
Host: measurement-web-dev.xymind.cn
Content-Type: application/x-www-form-urlencoded
appId=3a0e6cb1f0dfc6ff708caf8dea9f6c24&sdkKey=3a0e6cb1f0df0536d05625809aaa2329
1
2
3
4
2
3
4
响应示例
http
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkE4RDkyOTNENzlBNUEzRUVFQ0JGQTRCNEVCNkQwMkZFIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2NzMzNDU1MTYsImV4cCI6MTcwNDg4MTUxNiwiaXNzIjoiaHR0cDovL2F1dGgiLCJhdWQiOiJNZWFzdXJlbWVudE1lc3NhZ2UiLCJjbGllbnRfaWQiOiJNZWFzdXJlbWVudF9IYWllciIsImlhdCI6MTY3MzM0NTUxNiwic2NvcGUiOlsiTWVhc3VyZW1lbnRNZXNzYWdlIl19.Zd5uprJZz4YaGXoJtStRCLdu2nyTy3wbL_Y36ssfbE_j5nwWNVUuYvME-qOmSU4d9RapNGmhXyXA7SrcVsAvRg74cOaPRaB7eCKAFhjpkilMGO2ZU-nxzJaZbPjQTpVI6W7RFvVZmOMhI7eFzsKnYip-CRVXGtfawfwgXfCJZq2BFjovCDfUe3-gR5aBnyb1XKE_8sggwy1SnWUvVadSHp8fqzbjFDmgZWZFsgBaOWNbTjB4JSM2eDSW_gTMv2CJQ0wvmzkhdnC7TNS_I0-PvwqeLa-0wKcKB14wc-Xqh2Mhimpjey_ePegs_zdGlhr-gklqPF4WDsfAewFzXh6qPw",
"expires_in": 31536000,
"token_type": "Bearer",
"scope": "MeasurementMessage"
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
- 认证失败
请求示例
http
POST /auth/connect/sdk/token HTTP/1.1
Host: measurement-web-dev.xymind.cn
Content-Type: application/x-www-form-urlencoded
appId=xxxxx&sdkKey=yyyyyyy
1
2
3
4
2
3
4
响应示例
http
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=UTF-8
{
"error": "invalid_client"
}
1
2
3
4
5
2
3
4
5