Skip to content

用户认证

用户认证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

请求头

名称类型必需示例值描述
Content-Type字符串application/x-www-form-urlencoded
Accept-Language字符串zh-Hans

请求参数

名称类型必需示例值(勿用,仅作示例)描述
appId字符串3a0e6cb1f0dfc6ff708caf8dea9f6c24APP_ID 从管理控制台获取
sdkKey字符串3a0e6cb1f0df0536d05625809aaa2329SDK_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

响应示例

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"
}
  • 认证失败

请求示例

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

响应示例

http
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=UTF-8
{
    "error": "invalid_client"
}

Released under the MIT License.