[隐藏]

目录

  • 1、API介绍

    HTML5 API是原创平台专门为HTML5小游戏推出的一系列API的集合,包括积分排行榜API、广告API两种。开发者可根据游戏实际需要自主决定是否添加API。

    原创平台HTML5开发群:421323289

    原创平台技术支持:100584399

  • 2、使用案例

    2.1.积分排行榜API案例

    2.2.广告API案例

  • 3、添加步骤

    在添加4399HTML5 API前,请先在页面<body>标签下加入以下代码

    <script src="http://h.api.4399.com/h5mini-2.0/h5api-interface.php"></script>
    以下接口示例都是在JS中使用

    3.1.进度API

    展现4399播放页,控制进度条进度的方法。

    (1)游戏没有自带进度条及UI时,请调用此进度并提供对应的进度值,保证进度值达到100时进入游戏时,游戏处于等待玩家进入的准备状态。

    (2)游戏有自带进度条及UI时,可不添加此进度条API。

    /**
     * 控制进度条播放进度
     *
     * @param num  播放进度,值为0到100
     */
    window.h5api.progress(50)
                                    

    3.2.积分API

    3.2.1.提交积分到排行榜

    /**
     * 提交积分
     *
     * @param score    需要提交的积分
     * @param callback 提交积分完成或失败时回调的函数
     */
    window.h5api.submitScore(123, callback)
    /**
     * 此callback回调函数的形式
     *
     * @param obj 提交状态
     */
    function callback(obj){
        console.log('代码:' + obj.code + ',消息:' + obj.message + ',数据:' + obj.data)
        if(obj.code === 10000){
            console.log('上传成功')
        } else {
            console.log('上传失败')
        }
    }
                                    

    3.2.2.获取排行榜

    /**
     * 获得排行榜
     * @param callback   获取排行榜完成或失败时回调的函数
     */
    window.h5api.getRank(callback)
    /**
     * 此callback回调函数的形式
     *
     * @param obj 排行榜数据
     */
    此callback回调函数的形式
    function callback(obj){
        console.log('代码:' + obj.code + ',消息:' + obj.message + ',数据:' + obj.data)
        if(obj.code === 10000){
            console.log('获取成功')
            var data = obj.data
            for(var i = 0; i < data.length; i++){
                console.log('积分:' + data[i].score + ',排名:' + data[i].rank);
            }
        } else{
            console.log('获取失败')
        }
    }
                                    

    3.3.广告API

    添加此API需提前跟商务联系,qq:2853316645。广告API相关规范案例:激励广告合作规范激励广告设计案例

    3.3.1.此接口返回当前是否还有广告资源可播放,开发者应根据此接口确定是否需要展示播放广告的按钮及相关游戏流程。

    /**
     * 是否可以播放广告
     * @return boolean 是否可播放
     */
    window.h5api.canPlayAd()
                                    

    3.3.2.播放全屏广告,并获得广告播放状态。

    PS:当广告被浏览器自带或净网大师等工具拦截时,依然返回广告异常错误的状态码。

    /**
     * 播放全屏广告
     * @param callback   播放广告时的广告状态回调函数
     */
    window.h5api.playAd(callback)
    /**
     * 此callback回调函数的形式
     *
     * @param obj  广告状态
     */
    function callback(obj){
        console.log('代码:' + obj.code + ',消息:' + obj.message)
        if(obj.code === 10000){
            console.log('开始播放')
        } else if(obj.code === 10001){
            console.log('播放结束')
        } else {
            console.log('广告异常')
        }
    }
                                    

  • 4、常见问题解答

    4.1.原创平台对HTML5游戏有什么要求?

    游戏内容需原创,尺寸不能过大,需控制在800*600之内,并且适配主流手机屏幕,需要添加原创平台HTML5游戏基础API服务。

    4.2.原创平台积分排行榜服务需要用户登陆吗?

    目前原创平台为HTML5游戏提供的积分排行榜服务采用匿名提交方式,用户无需登录即可提交分数。

    4.3.关于其他引擎调用4399H5API接口的说明和案例。(https://github.com/yswnldy/h5mini-2.0-sample)

    4.4.HTML5游戏如何测试?

    开发者在添加完H5API的相关接口后上传到原创平台,即可预览测试H5API的添加使用是否正常。

    4.5.更多HTML5常见问题见HTML5常见问题解答 。