Skip to content

功能规格 ​

这一页说明 InkJoy Merchant API 和 Device Setup SDK 能做什么。字段级契约以开通商户后发放的 Apifox 预览为准——本页不编造路径。

依据:《基于 InkJoy API 的开发对接指南》。

Merchant API 是给商户业务系统 / App 用的 HTTP 接口。Device Setup SDK 负责把设备配上网并绑到你们的用户。配网完成后,由你们的服务或 App 用这套 API 管理用户、查设备、下发图片。

Merchant API ​

能力说明适用详解
创建 / 更新用户配网前用你们的 externalUserId 在平台注册或更新用户,拿到平台 uid。没有这一步,SDK 不能绑设备已授权商户用户
查询用户按 externalUserId 查用户信息已授权商户用户
查询设备列表该用户已绑定的设备及在线状态已授权商户设备
更新设备信息修改名称、描述、方向、自动 OTA 等已授权商户设备
解绑设备把设备从该用户下解除绑定已授权商户设备
下发图片向设备推送一张图(文件 或 图片 URL)。设备联网后拉取并显示已授权商户下发图片
查询播放进度本次下发是处理中、成功还是失败已授权商户下发图片

用商户凭证 apiKey / apiSecret 调接口。用你们自己的用户 ID 作为 externalUserId。底层设备协议和云端调度由平台完成。

完整请求预览(有密码;在 InkJoy 注册商户后可获得 API key):

Apifox 商户 API 预览

Device Setup SDK ​

能力说明适用详解
发现设备蓝牙扫描附近的 InkJoy 设备Android 商户 AppSDK
配置入网把用户选择的 Wi-Fi 下到设备,使其联网并接入 InkJoy 云Android 商户 AppSDK
绑定账号配网完成后把设备绑到商户侧用户(externalUserId)Android 商户 AppSDK

用同一套 apiKey / apiSecret 初始化 SDK。引导用户:扫描 → 输入 Wi-Fi → 确认配网。蓝牙、云端校验、绑定由 SDK 内部完成。

API 和 SDK 怎么配合 ​

  1. 调用「创建 / 更新用户」,拿到 uid。
  2. 用 SDK 完成扫描、配网、绑定。
  3. 之后用本 API 查设备、改信息、下发图片、查播放结果。

OpenAPI 体验(不是商户 API) ​

能力说明适用详解
消费级 OpenAPI正式成为商户前可体验的另一套 HTTP 服务,用来理解拉设备、裁切、旋转、发布公开体验OpenAPI 体验
Web toolopenapi.inkjoyframe.com 上的纯 HTML 示例公开体验OpenAPI 体验
1200×1600 发布该体验的 publish 只接受 1200×1600 的 PNG/JPG。横屏须先旋转仅体验环境OpenAPI 体验

不要把 OpenAPI 的路径或 1200×1600 限制当成已授权商户 API 的契约。

相关阅读 ​

ePaper Frame API Docs