@intlsdk/compliance-api v0.5.2
Compliance-API WEB 集成教程
合规服务流程
参考:https://developers.intlgame.com/docs/intlsdk/Module/Compliance
快速使用
第一步:引入 SDK
目前已支持
npm包
方式和CDN
方式
npm 方式
$ npm install @intlsdk/compliance-api
CDN 方式
//联调环境SDK包
<script src="https://test-common-web.intlgame.com/sdk-cdn/compliance-api/index.umd.js"></script>
//现网环境SDK包
<script src="https://common-web.intlgame.com/sdk-cdn/compliance-api/index.umd.js"></script>
第二步:使用 SDK
1、实例化对象
const complianceApi = new IntlgameComplianceApi({
env: 'test', //sdk运行的环境,详见下“env说明”:)
});
env 说明:
测试联调阶段,提供
联调环境
:统一联调:'test'LonelyFish 联调:us-test(未部署)
现网环境
(正式环境):新加坡:'sg'北美:'na'北美 aws(AOV 专有):'aws-na'俄罗斯(AOV 专有):'mos'日本:'jp'欧洲:'eu'南美(AOV 专有):'sa'LonelyFish:'lonelyfish'硅谷:'us'
2、设置用户登录态信息和配置信息
complianceApi.setUserProfile(
{
gameID: 11,
openID: 'xxx',
token: 'xxx',
channelID: 52,
region: '156',
},
(res) => {
console.log(res);
},
);
功能详细介绍
API 说明文档
setUserProfile
设置用户登录态信息和配置信息
Request parameters:
Parameter | Type | Description |
---|---|---|
gameID | number | INTL/iTOP/MSDKV5 的 gameID 配置,在配置文件中可获取 |
openID | string | INTL 用户唯一标识,默认为 64 bit 无符号整数的字符串,也可以支持 32 位 |
token | string | INTL 生成的用户 token,长度 40 字节 |
channelID | number | 渠道 ID |
region | string | 用户国家或地区码,引用 ISO_3166-1 标准 ;例如 "156" 代表中国 |
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
Demo
api.setUserProfile(
{
gameID:11,
openID:'xxx',
token:'xxx',
channelID:52,
region:'156',
},
(res) => {
console.log(res);
},
);
response log:
{
msg: "success",
ret: 0
}
queryUserStatus
查询用户未成年信息
Request parameters:
无
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
adult_check_status | number | 是否已经成年-1:还未成年0:还未设置1:已经成年 |
adult_check_status_expiration | string | 未成年状态下次需要认证时间 |
parent_certificate_status | number | 是否已经通过家长认证-1:家长拒绝认证0:家长未进行认证1:家长通过认证10:家长认证之中,邮箱认证特有 |
parent_certificate_status_expiration | string | 家长拒绝认证之后,下次可以认证时间 |
eu_user_agree_status | number | 欧盟玩家是否同意在非欧盟地区存储数据 -1:拒绝0:未设置1:同意 |
ts | string | 当前时间戳 |
adult_age | number | 入参国家的成年标准,查询不到使用默认成年标准 |
game_grade | number | 入参国家的分级标准,查询不到使用默认分级标准 |
certificate_type | number | 入参国家的认证类型,查询不到使用默认认证类型0:不认证1:自我认证2:信用卡认证3:邮箱认证 |
region | string | 用户国家或地区码,引用 ISO_3166-1 标准 ;例如 "156" 代表中国 |
Demo
api.queryUserStatus(
(res) => {
console.log(res);
},
);
response log:
{
adult_age: 0
adult_check_status: 1
adult_check_status_expiration: "1636375714"
certificate_type: -1
eu_user_agree_status: -1
game_grade: 0
msg: "success"
parent_certificate_status: 1
parent_certificate_status_expiration: "0"
region: "156"
ret: 0
seq: "1636530872-0180225310-023426-0000428179"
ts: "1636530872"
}
setParentCertificateStatus
用户设置家长认证状态
Request parameters:
Parameter | Type | Description |
---|---|---|
parentCertificateStatus | number | 玩家是否同意自我认证 -1:拒绝0:未设置1:同意 |
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
Demo
api.setParentCertificateStatus(
{
parentCertificateStatus:-1,
},
(res) => {
console.log(res);
},
);
response log:
{
msg: "success",
ret: 0
}
setAdulthood
设置用户是否已成年
Request parameters:
Parameter | Type | Description |
---|---|---|
adultCheckStatus | number | 用户成年标示 -1:未成年0:未设置1:已成年 |
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
Demo
api.setAdulthood(
{
adultCheckStatus:1,
},
(res) => {
console.log(res);
},
);
response log:
{
msg: "success",
ret: 0
}
CommitBirthday
提交用户出生年月(暂不支持信用卡认证,后续版本规划)
Request parameters:
Parameter | Type | Description |
---|---|---|
birthday | string | 玩家出生日期,格式支持 yyyy-mm 或 yyyy-mm-dd |
adultAge | number | 玩家所在国家地区的成年标准 |
gameGrade | number | 玩家所在国家地区的游戏分级的年龄标准 |
certificateType | number | 入参国家的认证方式,查询不到使用默认认证方式 -1:未知0:不需要认证1:自我认证2:使用信用卡支付认证(暂不支持信用卡认证)3:邮箱认证 |
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
adult_check_status | number | 是否已经成年-1:还未成年0:还未设置1:已经成年 |
Demo
api.setAdulthood(
{
birthday:'2000-01-01',
adultAge:18,
gameGrade:16,
certificateType:0,
},
(res) => {
console.log(res);
},
);
response log:
{
adult_check_status: 1,
msg: "success",
ret: 0,
seq: "1636535835-1006943754-007094-0000351947",
}
sendEmail
发送家长认证邮件
Request parameters:
Parameter | Type | Description |
---|---|---|
string | 目标电子邮箱地址 | |
userName | string | 邮件称呼 |
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
Demo
api.sendEmail(
{
email:'921127639@qq.com',
userName:'test'
},
(res) => {
console.log(res);
},
);
response log:
{
msg: "success",
ret: 0,
seq: "1636536177-1006943754-007094-0000352128",
}
setEUAgreeStatus
设置欧盟地区用户数据传输协议
Request parameters:
Parameter | Type | Description |
---|---|---|
euUserAgreeStatus | number | 欧盟玩家是否同意在非欧盟地区传输数据-1:拒绝0:未设置1:同意 |
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
Demo
api.setEUAgreeStatus(
{
euUserAgreeStatus:-1
},
(res) => {
console.log(res);
},
);
response log:
{
msg: "success",
ret: 0,
seq: "1636537938-1006943754-007094-0000353023",
}
queryIsEEA
查询 EEA 国家
Request parameters:
Parameter | Type | Description |
---|---|---|
region | string | 用户国家或地区码,引用 ISO_3166-1 标准 ;例如 "156" 代表中国 |
Response parameters:
Parameter | Type | Description |
---|---|---|
ret | number | 结果返回码0:请求成功,可以解析相关返回字段信息 !=0:请求逻辑失败, msg 里面有具体错误信息 |
msg | string | 结果说明 |
is_eea | boolean | 是否是 EEA 国家true:EEA 国家false:非 EEA 国家 |
Demo
api.setEUAgreeStatus(
{
region:'156'
},
(res) => {
console.log(res);
},
);
response log:
{
msg: "success",
ret: 0,
is_eea: false,
seq: "1636544186-1006943754-007094-0000355444",
}
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago