如何获取 OpenInstall开放平台 API 密钥(分步指南)

在移动应用推广和数据分析领域，OpenInstall开放平台 API 提供了强大的功能，能够帮助开发者轻松实现精准的用户来源追踪与分析。通过集成该API，开发者可以有效获取详细的用户数据，为优化推广策略和提升转化率提供重要支持。本文将指导你如何获取openinstall开放平台API密钥，并进行初步的可用性测试，同时探讨在使用过程中需要考虑的其他关键因素。

获取openinstall开放平台 API秘钥步骤

1、注册账号

点击注册，进入注册页面，注册openinstall账号。

2、创建应用

点击登录，进入登录页面。使用已注册成功的openinstall账号登录。登录成功后，进入控制台界面。点击界面左上角的【+创建应用】。

3、Android/iOS/Harmony SDK集成

3.1、根据开发环境选择对应的集成文档
点击应用控制台界面的【Android/iOS/Harmony集成】，进入对应的集成页面。开发者根据自身的开发环境选择对应的集成文档进行集成，默认的文档为原生项目的文档。如果非原生开发项目请选择【客户端集成插件】，找到对应类型的文档。
注：集成中所需要用到的AppKey、scheme、关联域名(Associated Domains) 均可在【Android集成】、【iOS集成】、【Harmony集成】中对应的【应用配置】中查看到。

3.2、根据开发环境选择对应的集成文档
找到对应的文档后，按照文档的集成流程进行插件导入、文档代码集成加入操作。

4、应用信息配置

SDK集成操作完成后，需要将应用的相关配置信息填充到控制台。填充方式分为：自动配置、手动配置。
自动配置：导出集成完毕的App测试包上传至控制台，上传后系统会自动解析安装包进行信息填充。
手动配置：无需导出App测试包，直接填写对应的应用信息在对应位置后保存即可。

5、功能测试验证

5.1、【App传参安装功能测试】：
（1）打包上传测试
测试前需要先卸载手机上已安装的App。访问Android集成、iOS集成界面右上角的【在线测试】网页或已集成【Web集成】文档的网页下载安装App，并启动App，最后查看安装参数获取方法（getInstall）中自定义参数的获取情况。
（2）真机调试测试
测试前需要先卸载手机上已安装的App。访问Android集成、iOS集成界面右上角的【在线测试】网页或已集成【Web集成】文档的网页，打开网页后点击一下网页上的下载按钮，但不用确认下载。然后使用开发工具（例如AndroidStudio、Xcode等）安装app到该手机上并启动，最后查看安装参数获取方法（getInstall）中自定义参数的获取情况。
5.2、【一键拉起功能测试】：
在手机上安装好对应的App，然后访问【在线测试】网页或已集成【Web集成】文档的网页，点击按钮，会唤醒对应的App。然后查看唤醒回调方法（wakeup）的唤醒参数的获取情况。
5.3、【H5渠道统计功能测试】：
进入openinstall账号应用中的【H5渠道统计】模块的【H5渠道管理】，创建渠道链接，然后参考5.1点的【App传参安装功能测试】规则测试即可。渠道链接测试才能获取到对应的渠道编号。

6、正式使用前需要做的准备工作

6.1、自行开发网页集成【Web集成】文档
openinstall控制台所提供的测试网页仅供开发者功能测试验证用途，禁止用于正式环境正式使用。因此开发者正式使用时需要自行开发下载落地页（H5），然后网页中需要集成【Web集成】文档，来达到与测试页一样的功能。 JavaScript集成或者App banner集成，二选一即可:

6.2、安装包下载地址配置
高级版：付费开通后支持上传安装包下载，Android推荐使用“常规路由”或“加速路由（需消耗加速路由流量包）”，也可以选择自行配置下载地址在对应下载地址栏中（Android为“自定义下载地址”，iOS为“Appstore或其他”）。

初级版：openinstall测试包仅供功能测试验证，禁止在正式环境大量使用。因此开发者需要自行提供安装包地址配置到对应的下载配置中。

6.3、开发者认证
初级版和高级版在正式使用前都需要进行开发者认证。否则【初级版】会存在每日ip测试上限，【高级版】会存在每日ip测试上限以及无法付费开通。

7、正式使用或付费开通

【初级版】：进入【基本信息】，手动切换至“初级版”即可。注意：“高级版”付费开通后无法切换回“初级版”。
【高级版】：进入应用控制台界面的【基本信息】，点击【商用支付】选择对应的服务套餐付费开通即可。

8、查看API密钥

在应用页面左侧导航栏中应用集成>数据接口可以查看到密钥

提示：应用及渠道的所有统计数据，均以HTTP接口的形式向开发者开放，开发者可通过这些数据接口抓取数据自行存储，或做报表二次开发；数据接口默认关闭。

2. openinstall开放平台 API密钥可用性测试

在获取API密钥后，进行可用性测试是确保其正常工作的重要步骤。以下是使用curl进行测试的一个案例

以下接口为openinstall开放平台数据接口中的渠道分组列表接口

输入：

curl -X GET "https://data.openinstall.io/data/group/list" \
-H "Content-Type: application/json" \
-H "apiKey: <您的API_KEY>"

输出：

你将得到一个JSON格式的响应，其中包含了当前应用下所有的渠道分组信息。

示例输出：

{
  "code": 0,
  "error": null,
  "body": [
      {"groupName":"default"},
      {"groupName":"巨量"},
      {"groupName":"百度OCPC"},
      {"groupName":"分享"}
  ]
}

3. 使用openinstall开放平台 API搭建应用的其他关键考虑因素

在使用openinstall开放平台 API搭建应用时，除了获取和测试API密钥外，还需考虑以下因素：

数据接口

应用及渠道的所有统计数据，均以HTTP接口的形式向开发者开放，开发者可通过这些数据接口抓取数据自行存储，或做报表二次开发。

接口配置

请开发者注册并登录openinstall后台，找到【数据接口】-【接口配置】，开启数据接口开关等配置。

兼容性与平台支持

在开发应用时，确保 OpenInstall 的 API 能够无缝支持 Android 和 iOS 操作系统。考虑到不同操作系统的要求，选择适合的开发框架，并确保 API 在这些平台上都能正常工作。此外，还要考虑设备的不同型号和操作系统版本，确保应用的兼容性。

合规性与用户隐私保护

在使用 OpenInstall API 时，必须确保符合相关隐私法规。这意味着开发者需要清楚地告知用户其数据如何被收集、使用和存储，尤其是有关渠道和用户行为数据的收集。开发者应确保应用的隐私政策清晰透明，并采取适当的措施来保障用户隐私。

第三方工具与服务集成

若应用需要与第三方广告平台（如 Google Ads、Facebook Ads）或数据分析工具（如 Google Analytics、Mixpanel）集成，开发者应确认 OpenInstall API 与这些工具的兼容性。通过与其他服务的集成，开发者可以获得更多的推广渠道和深入的用户行为分析。

4. openinstall开放平台 API密钥申请和使用中的常见问题

在申请和使用 openinstall开放平台 API密钥过程中，你可能会遇到以下常见问题：

1.App传参安装方法（getinstall）每次进入都会回调怎样避免？

SDK初始化成功后内部将会一直保存安装参数，每次调用App传参安装方法都会返回安装参数。如果开发者并不需要每次进入App都触发此方法，可以将该方法放在业务场景真正需要获取安装参数时调用，其次在获取完成后如果不需要再次获取时，可以通过自行设置标识以便于下次不再调用此方法。

2.作为OpenInstall用户，自己应用的下载链接或二维码在哪里获取？

OpenInstall平台提供的【在线测试】链接、二维码和“系统默认”的渠道链接、二维码仅供测试。

若OpenInstall用户想要在自行开发的网页中实现与“测试页”相同功能，则需要在自行开发的网页中加入【web集成】-【JavaScript集成】或【App banner集成】文档，从而实现App传参安装、渠道统计、一键拉起、快速安装等功能。（网页链接可以使用工具转换成二维码图片，此时的链接与二维码功能等效）

3.微信/支付宝小程序中显示OpenInstall相关域名未非业务域名的处理办法？

（1）当微信/支付宝小程序中加载集成了OpenInstall web集成文档的网页时，可能会出现：不支持打开非业务域名https://xxxxxx.openinstall.io，请重新配置。如果出现此类提示，则属于OpenInstall相关域名未在对应的小程序中进行白名单验证，从而不属于业务域名禁止访问。（2）验证流程： ①按照小程序平台的验证规则，将对应的验证文件（.txt或.html文件）发送至OpenInstall官方人员，官方人员会转交技术将文件配置到对应域名的根目录下。 ②添加对应域名根目录下后，就可以进行验证了。验证成功后告知OpenInstall官方人员即可（验证成功后OpenInstall会清除该验证文件）。

4.怎样为应用开通或续费？

（1）进入OpenInstall控制台中对应的应用，然后进入应用控制台的【基本信息】，即可看到开通/续费选项（初级版无付费选项）。（2）进入OpenInstall控制台，点击界面右上角的【财务】-【我的钱包】充值所需的费用。然后回到应用列表为对应的应用开通/续费。（3）在OpenInstall控制台的应用列表也可以为应用开启自动续费，须保证【我的钱包】中余额充足，否则会影响自动续费。

5. openinstall开放平台 API进阶指引

在获得openinstall开放平台 API密钥之后，即可开启API接口对接，本文整理了多篇使用openinstall开放平台 API的案例，帮助读者更有效地使用openinstall开放平台 API：

渠道详情、渠道创建/修改、子渠道列表、新增安装数据、活跃数据、新增设备分布

6. 常见问题

问题1：什么是幂简集成平台？

幂简集成是蜜堂有信在2023年打造的一款SAAS产品，建设着国内最全的API平台，为开发者提供全面、高效、易用的API集成管理方案，一站搜索、试用、集成国内和国外API。让用户在AI时代全方位接入互联网，用API连接一切服务和算力，实现价值倍增。

问题2：如何找到openinstall开放平台 API

幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’openinstall开放平台 API‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。

更多竞品可以在openinstall开放平台找到。

7. 总结

本文介绍了openinstall开放平台的API密钥获取、测试及应用开发过程中的关键考虑因素。首先，我们通过curl命令演示了如何测试API密钥的可用性。接着，阐述了使用API搭建应用时的其他重要注意事项，包括数据接口、接口配置、平台兼容性、用户隐私保护以及第三方工具集成。此外，还解决了在API密钥申请和使用过程中可能遇到的常见问题，并提供了进阶使用指引和相关链接，帮助开发者更好地应用openinstall平台的API进行开发和集成。