获取CUID API
最近更新:2023-09-21
获取CUID API
在运营增长平台中,是以 CUID 是作为平台用户唯一ID的,您可以通过【数据中心】-【用户资产管理】-【One ID】中创建自有系统的用户标识,并通过开启唯一性,从而与CUID一对一映射。
通过下面的API您可以通过 用户标识 换取 CUID 。
API获取 CUID 必须基于 用户标识 进行获取,且该用户标识已存在于运营增长平台的数据中心。
注意:用于获取 CUID 的用户标识必须在 ID Maping 中设置为第1优先级,否则运营增长平台将无法将您自有系统的用户标识的 CUID 进行一对一映射
请求方式
POST
请求地址
POST https://growth.jiguang.cn/smartop/api/v1/user/register
POST https://growth.jiguang.cn/smartop/api/v1/user/register
此代码块在浮窗中显示
QPS限制
QPS≤100
请求头
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
此代码块在浮窗中显示
请求体参数
接口支持一次获取单个CUID或多个CUID上报,获取多个时,identityValues数量≤100 个。
真实业务场景下,请不要携带注释,下方示例的注释仅为帮助开发者理解参数意义
{
"identityName":"phone_test", //用户标识名称
"identityValues": [
"18012345678", //用户标识value值
"18012345678"
]
}
{
"identityName":"phone_test", //用户标识名称
"identityValues": [
"18012345678", //用户标识value值
"18012345678"
]
}
此代码块在浮窗中显示
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
identityName | String | 是 | 用户标识名称,可用于自定义自有系统用户标识 |
identityValues | list | 是 | 用户标识的值,最多支持100个值,每个值不能超过256个字符 |
- 用户标识名称需要提前在平台中创建,建议开发人员先行查看用户标识列表,再配置相应的用户标识值。
- 值的个数超过限制或每个值的字符数量超过上限均会请求失败。
响应参数
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
code | Int | 是 | 接口调用是否成功,0表示成功,其他值代表出错 |
msg | String | 是 | 接口调用结果描述,对错误码的文字说明 |
data | Array | 否 | cuid列表 |
identityValues | String | 是 | 用户标识的值 |
cuid | Long | 是 | 对应运营增长平台用户唯一ID |
errorCode | Int | 是 | cuid是否获取成功,0代表成功,其他值代表出错 |
成功响应
{
"code": 0,
"msg": "ok",
"data": [
{
"identityValue": "18012345678", //用户标识value值
"cuid": 10362473, //生成的对应的cuid值,失败为null值
"errorCode": 0 //对应的错误码,成功是为0,失败时不为空,例如40006
},
{
"identityValue": "18012340000",
"cuid": 10362474,
"errorCode": 0
}
]
}
{
"code": 0,
"msg": "ok",
"data": [
{
"identityValue": "18012345678", //用户标识value值
"cuid": 10362473, //生成的对应的cuid值,失败为null值
"errorCode": 0 //对应的错误码,成功是为0,失败时不为空,例如40006
},
{
"identityValue": "18012340000",
"cuid": 10362474,
"errorCode": 0
}
]
}
此代码块在浮窗中显示
失败响应
单个错误响应:
{
"code": 40006,
"msg": "用户标识不存在"
}
{
"code": 40006,
"msg": "用户标识不存在"
}
此代码块在浮窗中显示
多个错误响应:
{
"code": 0,
"msg": "ok",
"data": [
{
"identityValue": "18012345678", //用户标识value值
"cuid": null, //失败为null值
"errorCode": -1 //对应的错误码,成功是为0,失败时不为空
},
{
"identityValue": "18012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000080123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
"cuid": null,
"errorCode": 40006
}
]
}
{
"code": 0,
"msg": "ok",
"data": [
{
"identityValue": "18012345678", //用户标识value值
"cuid": null, //失败为null值
"errorCode": -1 //对应的错误码,成功是为0,失败时不为空
},
{
"identityValue": "18012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000080123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
"cuid": null,
"errorCode": 40006
}
]
}
此代码块在浮窗中显示
错误码
错误码 | 错误码说明 | 解决措施 |
---|---|---|
4009 | 接口鉴权失败 | 确认项目ID和项目密钥是否正确 |
40004 | 用户标识为空 | 确认请求体中用户标识的值是否为空 |
40005 | 用户标识不存在 | 确认是否在运营增长平台中创建了用户标识 |
40006 | 用户标识value值不能超过256个字符 | 确认用户标识的值是否超过256个字符 |
40011 | 用户标识个数超限 | 确认用户标识的值的数量是否超过100个 |
-1 | 服务器内部错误 | 请联系极光技术支持 |
文档内容是否对您有帮助?