WapRegister - 生成用户标识--内容定制-火山引擎

文档中心

立即注册

导航

WapRegister - 生成用户标识

最近更新时间：2024.05.28 18:13:34首次发布时间：2021.10.18 11:12:18

wap注册接口主要用于生成用户唯一标识，该标识将用于火山引擎侧的推荐系统，进行个性化推荐。

注意事项

使用限制
- 用户安全：不要使用用户的明文信息，保护用户信息不泄露。
- AccessToken有效期较长，目前为60天左右，建议客户侧研发把AccessToken缓存起来。
- 当AccessToken过期时或无效时，接口返回值中将出现error。此时需要重新使用注册接口获取AccessToken。
- 不要使用同一个uuid并发请求注册，否则返回错误。
- 同一个用户uuid要保证唯一且不变，不同用户不可共用同一个uuid，否则将影响推荐效果。

请求说明

请求方式：GET/POST(Content-Type: application/x-www-form-urlencoded)
请求地址：https://mercury.volcengineapi.com/?Action=WapRegister&Version=2021-01-01
请求头：ServiceName:content

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	WapRegister	要执行的操作，取值：WapRegister。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Partner	String	是	demo_default_content	渠道号。请登录火山引擎内容定制控制台-应用管理-查看详情，查找对应“渠道号”。
Uuid	String	是	user_unique_id	客户侧用户唯一标识，如设备标识或客户侧自有的账号体系，比如用户邮箱、imei、mac地址、自增id等，也可以是加密的id等，长度不超过64。
Ouid	String	否		客户侧登录用户ID。同一个设备上用户由非登陆变为登陆态，需要使用相同的Uuid绑定此Ouid进行注册请求；以后每次请求注册都需要同时传入Uuid+Ouid，否则会被认为退出登陆，变成新用户。
Age	Integer	否	20	年龄，0～100的数字。
Gender	String	否	f	性别。女：f，男：m。
Birth	Integer	否	1998	出生年份.

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AccessToken	String	AT6zTZuXzffKpQamerBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLms***UipuJNh2piKTT12	火山侧生成的用户唯一标识。说明建议缓存起来，在AccessToken过期前一周，使用相同Uuid，重新调用用户注册接口获取标识。
ExpiresIn	Long	5184000	AccessToken有效期，单位：秒。用户标识的有效期，一般是60天，即：5184000。

请求示例

GET /?Action=WapRegister&Version=2021-01-01&Partner=demo_default_content&Uuid=user_unique_id HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=WapRegister&Version=2021-01-01
X-Date: 20240521T070059Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240521/cn-beijing/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240521150213189176031222EC36E2",
    "Action": "WapRegister",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-beijing"
  },
  "Result": {
    "AccessToken": "AT6zTZuXzffKpQamerBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLms***UipuJNh2piKTT12",
    "ExpiresIn": 5184000
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。