1.准备工作
1.1 申请API对接所需的材料
步骤一：联系商米售前技术团队，申请对接API所需要的账号信息，需要向售前技术支持团队提供如下软件开发商信息
| 客户提供的信息 | 说明 |
| 客户名称 | 软件商公司名称 |
| 对接摄像头型号 | 对接API的型号，如SS（Store Sense）、FS（Face Sense） |
| 客户设备的SN | 客户对接联调的所有设备的SN，需要商米云把这些SN加入到UAT环境 |
| 客户需求场景 | 描述大体的需求和使用场景 |
步骤二：售前技术团队根据客户的需求信息，返回软件商对接API所需的账号信息，包括
| 返回给客户的信息 | 说明 |
| SaaS代号 | 商米内部管理SaaS软件商信息的代号 |
| app_id | 激活设备端API所需的账号 |
| secret_key | 调用API所需的签名秘钥 |
| 设备激活码 | 激活设备端API所需的激活码，用于签名校对软件商是否有权调用 |
| 可激活的设备数量上限 | UAT环境下的可激活设备的数量 |
| openapi.bks | 双向验证中客户端自己的证书以及私钥。 |
| sunmica.bks | 双向验证中用于校验服务端发送过来的的证书是否合法。 |
| SDK开发包 | 用于对接的SDK，目前只支持安卓版本 |
| UAT环境商米助手APP | 用于在UAT环境下给设备做首配 |
1.2 设备刷机UAT环境固件
一般，软件商客户在开发对接API阶段，建议使用调试环境，即商米的UAT环境，避免对正式生产环境造成困扰或者数据污染。
因此，需要将摄像头的固件升级到开发测试环境（UAT环境），具体操作流程参考 升级开发环境固件。
另外，刷机到UAT环境后，可以使用UAT环境商米助手进行首次配置，使摄像机工作起来，后续集成了Android SDK后可以在开发者自己的应用上对摄像头进行配置，而无需商米助手。
2.OpenAPI简介
摄像头API提供强大的功能，几乎包含了摄像头本身具有的所有功能，用户可以通过这些API开发自己的功能并集成到自己的应用上。
API提供两种使用方式，用户可以选择其中一种方式来完成自己的开发，简单介绍如下：
方式一：直接根据API接口实现原理和接口细节（详见API调用方式），自己开发客户端代码调用API。
方式二：推荐的方式，根据商米提供的平台SDK（当前只支持安卓SDK，详见设备端Android SDK），直接调用JAVA API来完成对摄像头API的调用，不需要过多关注API的接口细节，方便快捷，节省开发时间。
后续的集成指南介绍都以安卓SDK来展开。
3. Android SDK简介
3.1 相关文档
| 序号 | 内容项 | 获取方式 | 说明 |
|---|---|---|---|
| 1 | SDK技术文档 | Android SDK技术文档。 | 包含了SDK的API说明与示例代码。 |
| 2 | SDK开发包 | 由技术支持提供给SaaS客户。 | 见章节3.2。 |
| 3 | SDK License | SaaS客户提供自身的客户信息进行申请，技术支持邮件发送给SaaS客户。 | License目前包含：app_id、secret_key、激活码 |
3.2 SDK开发包介绍
- SDK开发包组成
| 序号 | 文件/文件名 | 说明 |
|---|---|---|
| 1 | IpcDemo | Demo工程源码，可直接编译出Demo APP |
| 2 | ipcsdk.aar | OpenAPI库 |
| 3 | demo.apk | 编译好的Demo APP |
- Demo工程源码结构
4. Android SDK集成指南
详见设备端Android SDK集成指南。
5. 开发联调
激活设备API后，可以正式调用摄像头所有开发的API完成自己的业务开发和调试，测试通过后即可准备上线。
6. 正式上线
由于开发联调是在UAT环境完成的，因此，客户确认业务测试没有问题后，给客户正式使用的时候需要上线到正式环境，即商米的 Release环境。
可以给设备升级到正式环境，见升级线上环境固件的操作指南。在正式环境下回归测试OK后，即可正式发布。
