接入指南

按语:openinstall集成很简单

我们在集成流程上进行了创新,省去了一些环节和一些琐碎的工作,使得openinstall的集成变得更加简单和快捷。

集成时,请使用控制台里的集成文档进行集成,仅仅通过简单的复制粘贴,20分钟即可完成集成工作——之所以要用控制台的集成文档,是因为我们在这些集成文档中预设了Appkey等参数,可以免去你手动填写的这一步骤。

一、产品描述

openinstall的核心价值在于,帮助Android/iOS开发者通过openinstall提供的sdk,精确的获取app每一次安装的分享(或推广)来源。 大致原理如下:开发者在分享的h5页面上集成openinstall web sdk,发布分享链接时在url上动态的拼接任意的自定义参数(如推广渠道号,邀请码,游戏房间号等等); 当某一终端访问该h5页面时,openinstall web sdk将同时确定该设备的个性化信息和采集自定义参数,上传至openinstall服务器, 待用户通过该h5页面安装app后首次打开时(如当前设备已安装该app,将直接拉起该app并传递参数),使用openinstall Android/iOS sdk从openinstall服务器再取回暂存的自定义参数。 开发者根据各自的需求,在分享链接自定义各种动态参数。比如通过在分享链接url中附带app邀请人的用户id,就可达到免填邀请码的效果;对战类游戏app通过在url中附带游戏房间号,新老用户都可通过该url链接直接进入邀请人的对战房间; 更多使用场景均取决于开发者的需求。

openinstall通过标准的scheme,universal link等技术,在app已安装的情况下,从各种浏览器(包括微信、QQ、新浪微博、钉钉等主流社交软件的内置浏览器)拉起app并传递自定义参数,避免重复安装。

openinstall在精准的app分享来源跟踪的技术上,开发了免打包,跨平台的app渠道统计功能。 开发者可在openinstall平台快速创建渠道链接,app通过某一个渠道链接安装后,在openinstall Android/iOS sdk初始化时,将从openinstall服务器自动获取到本次安装的渠道编号(无需开发者在代码中手动设置渠道编号重新打包), 同时收集相关信息用于生成渠道报表数据(只包含机型,系统版本,ip等设备相关的信息,不包含任何业务相关的数据)。如需统计注册事件,开发者需结合自身业务,在用户注册成功的情况下调用openinstall相应的api,发送统计事件。

二、集成步骤

1、注册/登录openinstall开发者平台http://developer.openinstall.io/并创建应用

2、应用创建成功后,需要Android/iOS开发人员必要的sdk集成工作; openinstall开发者平台完全采用零配置,开发者只需根据sdk集成指引,逐步完成客户端集成,并导出apk/ipa安装包上传到openinstall平台。(上传安装包是为了方便Android/iOS开发人员快速集成测试,同时自动读取安装包配置信息,免除手工配置操作)

开始sdk集成:

根据指引逐步完成sdk集成工作:

导出apk/ipa安装包并上传;iOS开发者导出development/adhoc/enterprise类型的ipa包,即可通过网页在线安装,development/adhoc类型的包需在相应的privision中对测试设备进行UDID授权,具体的授权操作可联系我们技术支持或自行百度

3、Android/iOS sdk集成完毕并上传apk/ipa安装包后,可先使用openinstall提供的在线测试功能,确保app安装后能正确还原输入的动态参数。

随意输入一对参数名/参数值,生成二维码即可通过相应的Android/iOS设备开始测试工作。(实际应用中可附带多对不同的参数名/参数值)

4、经过在线测试确认sdk集成正确的情况下, Web开发人员可以开始在web分享页上集成openinstall Web api。openinstall目前提供两种Web集成方式,App banner及javascript api的集成。App banner集成复制一行<script>引用标签即可,javascript集成提供完整的api,适合高级用户。

5、对于有渠道统计需求的用户,在完成客户端sdk集成的前提下,即可开始创建渠道并测试统计效果