VIGOO休闲游戏接入文档

一 使用说明

1. 版本号：1.0.3，更新时间：2019年10月28日
2. 提交游戏前，请务必阅读接入指引文档，完成自测，谢谢！https://www.jianshu.com/p/0c62925c5ec1

二 接入流程

1. 请提供游戏地址给vigoo，地址需使用https

• 为方便调试，开发阶段可以先提供一个本地服务器地址，之后再提供海外服务器地址<西山居服务器>

2. vigoo返回游戏调试地址、Appkey

三 前端接口

1. 引入JS：https://sdk.vigoo.com/vigoo/sdk.js 示例：

<script type="text/javascript" 
src="https://sdk.vigoo.com/vigoo/sdk.js"></script>

2. vigoo.Login(callback) 登录callback参数

• 请务必接入
• 参数

属性	类型	说明
appid	string	产品ID
openid	string	用户ID
token	string	用户登录令牌

• 示例：

vigoo.Login((data) => {
    const appid = data.appid;
    const openid = data.openid;
    const token = data.token;
});

3. vigoo.HideLoading() 隐藏加载界面

• 说明：
  　－为了保证用户体验，在用户进入游戏时会显示一个加载界面，CP方根据需要调用此接口隐藏该加载界面。
  　－隐藏vigoo平台loading页的节点要求：隐藏后开始进入游戏自己的loading界面，中间不能出现黑屏等异常情况
• 示例：

setTimeout(() => {
    vigoo.HideLoading();
}, 1000);

4. vigoo.Share() 显示分享面板

• 示例

vigoo.Share();

5. vigoo.ShowTitleAdv(callback) 显示片头广告

• 说明：
  　－请务必接入
  　－使用PC浏览器端调试广告时，请把浏览器窗口切换至手机模式，否则广告可能不会正常展示
  　－游戏loading页完成进入游戏时，请CP调用片头广告
  　－请避免在进入游戏首页后再开始调用，避免被谷歌判定为误点击
  　－广告样式：倒计时5s的富媒体广告，可能展示文字、图片、视频等，由于AdSense广告视频填充率较低，所以广告一直展示图片样式是正常的<下同>
• 参数

属性	类型	说明
Type	string	广告状态1：播放失败，2：播放跳过，3：播放完成

• 示例：

vigoo.ShowTitleAdv((ret) => {
// ret.type = ‘1’表示播放失败
    const type= ret.type;
});

6. vigoo.ShowScreenVideo(nodeName,callback) 显示智能插屏广告

• 说明：
  　－请务必接入
  　－请在对接群与平台运营约定广告节点名称，平台运营配置之后才能调用插屏广告，名称尽量言简意赅，如：下一关、结算、签到等
  　－用户每次触发广告节点时，均需向平台发起广告请求，平台会根据算法自动调整每款游戏的广告展示策略
• 广告节点须知：
  　－请尽量在用户点击结算确认、下一关、返回桌面、切换菜单等操作结束后发起广告请求，避免在游戏正常操作过程中用户不知情的情况下发起请求
  　－部分游戏有新手引导，请在新手引导结束后再开始发起请求
• nodeName参数

属性	类型	广告状态
nodeName	string	节点名称

• callback参数

属性	类型	说明
Type	string	广告状态1：播放失败，2：播放跳过，3：播放完成

• 示例：

vigoo.ShowScreenVideo(nodeName, (ret) => {
// ret.type = ‘1’表示播放失败
    const type= ret.type;
});

image.png

7. vigoo.ShowExcitationVideoAdv(callback) 显示激励广告

• 说明：
  　－请务必接入
  　－收到回调：1，播放失败，需提示用户：Please try again later
  　－收到回调：2，播放跳过，需提示用户：You can get rewards after watching the full ad
  　－收到回调：3，播放完成，需给用户发放奖励，用户看完才能够获得奖励
  　－激励广告需要给与用户激励奖励，包括领双倍、复活、金币等均可，点击激励广告的按钮需要有看广告&看视频的文字提示或类似的图标提示

按钮样式参考

• callback参数

属性	类型	说明
Type	string	广告状态1：播放失败，2：播放跳过，3：播放完成

• 示例

vigoo.ShowExcitationVideoAdv((ret) => {
// ret.type = ‘1’表示播放失败
    const type= ret.type;
});

四 后端接口

1. 校验OpenID账号和token是否合法
   https://xboxsdk.vigoo.com/Account/CheckOpenID
   Method：Post

• 示例

<?php
// 以下参数改为平台所提供的值
$appid = '';
$Appkey = '';

// 以下参数改为从前端js sdk中获取到的值
$openid = '';
$token = '';

// 签名算法
$t = time();
$str = $t . $openid . $token . $appid . $Appkey;

$arr = array(
  't' => $t,
  'openid' => $openid,
  'token' => $token,
  'appid' => $appid,
  'sign' => md5($str)
);

echo http_post('https://xboxsdk.vigoo.com/Account/CheckOpenID', json_encode($arr));

function http_post($url, $data, $connTimeOut = 10, $timeOut = 10)
{
  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, $url);
  curl_setopt($ch, CURLOPT_HEADER, 0);
  curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
  curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connTimeOut);
  curl_setopt($ch, CURLOPT_TIMEOUT, $timeOut);
  curl_setopt($ch, CURLOPT_POST, 1);
  curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
  curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-type:application/json;charset=utf-8'));
  $rtn = curl_exec($ch);
  if ($errno = curl_errno($ch)) {
    throw new Exception(curl_error($ch), $errno);
  }
  curl_close($ch);
  return $rtn;
}

• 请求参数（json格式）:

参数名	说明
appid	产品ID
openid	用户ID
token	用户登录令牌
t	时间戳
sign	md5(t+openid+token+appid+appkey)

• 返回

参数名	必须	说明
code	Y	错误码 1成功