Skip to content

概览 ​

InkJoy Merchant API 是给商户自有业务系统 / App 用的 HTTP 接口,和 InkJoy Device Setup SDK 配合使用。

  • SDK 负责把设备配上网,并绑到你们的用户。
  • 这套 API 在配网完成后,让你们的服务或 App 管理用户、查设备、下发图片。

你们不用实现设备协议。云端调度由平台完成。

本站依据《基于 InkJoy API 的开发对接指南》。能力表见 功能规格。

API 覆盖什么 ​

  1. 商户用户 — 配网前用 externalUserId 注册或更新用户。没有这个用户,SDK 不能绑设备。
  2. 已绑定设备 — 查该用户下的设备和在线状态;改名称等信息;需要时解绑。
  3. 下发 — 向设备推一张图片(文件或 URL),再查播放进度:处理中 / 成功 / 失败。

你们要准备 ​

  • 商户凭证:apiKey / apiSecret
  • 用你们自己的用户 ID 作为 externalUserId
  • 配网走 SDK;用户、设备、解绑、下发走这套 API

不是这套 API ​

OpenAPI 体验(openapi.inkjoyframe.com)是另一套 HTTP,给还没注册商户的人试用。不要把它的路径或 1200×1600 限制写进商户 API 对接。

想要现成控制台、而不是自己接 API,请用 CMS。

ePaper Frame API Docs