数据 SDK

查询基于同意的用户数据

post

检查迷你应用中注册的基于同意的用户数据项的用户同意状态。如果用户已同意最新的同意内容，则返回实际数据值；如果尚未同意或拒绝同意，则返回可以跳转到同意页面的 URL，而不是数据。

业务错误码

以下错误将以 HTTP 200 和 resultType: FAIL 响应。

errorCode	说明
4010	找不到认证信息。

授权

mutualTLS

这是基于为合作伙伴签发的客户端证书的 mTLS 认证。通过证书的 CN 来识别迷你应用。证书签发·管理方法请参考 使用服务器 API 文档。

头参数

x-toss-user-keystring必填

用于验证用户的密钥。可通过 获取用户信息 API 获取

Example: 12345678

请求体

这是查询基于同意的用户数据的请求正文。

consentedUserDataKeystring必填

这是用于标识要查询的基于同意的用户数据项的键。通过在合作伙伴工作区控制台注册基于同意的用户数据项来发放。

Example: cud_1234567890abcdef1234567890abcdef

响应

200

这是请求处理结果。请根据 resultType 值区分成功/失败。

application/json

或

400

请求正文不符合格式。请在error.data.errorDetails中查看各字段详情。

application/json

500

未分类的服务器错误。如果持续失败，请联系合作伙伴支持渠道。

application/json

post/api-partner/v1/apps-in-toss/data-sdk/get-consented-user-data

POST /api-partner/v1/apps-in-toss/data-sdk/get-consented-user-data HTTP/1.1
Host: apps-in-toss-api.toss.im
x-toss-user-key: {userKey}
Content-Type: application/json

{
  "consentedUserDataKey": "cud_1234567890abcdef1234567890abcdef"
}

{
  "resultType": "SUCCESS",
  "success": {
    "type": "PROVIDED",
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}