WEB SDK 集成指南

CodeInstall提供完整的 javascript 和 App banner两种方便 Web 开发者实现完全自主的设计。

一、JavaScript 集成

集成到任何下载落地页面，直接复制以下代码到应用下载的落地页面代码中即可。

相关代码以及参数说明如下：

<!-- 以下为CodeInstall集成代码，建议在html文档中尽量靠前放置，加快初始化过程 -->
<!-- 强烈建议直接引用下面的cdn加速链接，以得到最及时的更新，我们将持续跟踪各种主流浏览器的变化，提供最好的服务；不推荐将此js文件下载到自己的服务器 -->
<!-- 注意：集成下载时需要人为点击触发执行（不能代码自动下载或者代码伪点击触发），否则影响参数的获取和精确度。 -->
<script type="text/javascript" charset="UTF-8" src="https://res.codeinstall.vip/codeinstall_activity/static/sdk/web_sdk.min.js"></script>
<script type="text/javascript">
    //CodeInstall初始化时将与CodeInstall服务器交互，应尽可能早的调用
    /*web页面向app传递的json数据(通过浏览器地址参数传递)，应用被拉起或是首次安装时，通过相应的android/iOS api可以获取此数据*/
    // customData参数：Object类型，为自定义参数，非必传，不传递时CodeInstall会传递 SDK 方法中的参数，若传递会覆盖 SDK 方法中的参数。
    var customData = CodeInstall.parseUrlParams();  // SDK 中提供的方法，解析url中所有参数。
    new CodeInstall({
        /*appKey必选参数，CodeInstall平台为每个应用分配的ID*/
        appKey : 您的appKey,
        /*可选参数，自定义android平台的apk下载文件名；个别andriod浏览器下载时，中文文件名显示乱码，请慎用中文文件名！*/
        /*CodeInstall初始化完成的回调函数，可选*/
        onready : function() {
            /*在app已安装的情况尝试拉起app*/
            this.schemeWakeup();
            /*用户点击某个按钮时(假定按钮id为downloadButton)，安装app*/
            var c = this, button = document.getElementById("downloadButton"); 
            button.style.visibility = "visible";
            button.onclick = function() {
                c.wakeupOrInstall();
                return false;
            }
        }
    }, customData);
</script>

二、App Banner 集成

详细的样式设置可以在 CodeInstall 控制台左侧菜单WEB集成 - App Banner集成中进行配置。将根据对应的配置自动生成App banner，同时收集分享页url上的动态参数，应用被拉起或是首次安装时，通过相应的Android/iOS客户端api可以获取此数据，可将页面中的代码复制到的Web分享页中完成对接。