Function Specs
This page lists what the InkJoy Merchant API and Device Setup SDK can do. Field-level contracts are in the Apifox preview issued with a merchant account — this page does not invent paths.
Source: 基于 InkJoy API 的开发对接指南.
Merchant API is the HTTP surface for your business system or App. Device Setup SDK puts a frame on Wi-Fi and binds it to your user. After that, your server or App uses this API to manage users, list devices, and publish images.
Merchant API
| Capability | What it does | Availability | Detail |
|---|---|---|---|
| Create / update user | Register or update a merchant user with your externalUserId before setup. The platform returns its uid. The SDK cannot bind a frame until this exists | Licensed merchant | Users |
| Query user | Look up that user by externalUserId | Licensed merchant | Users |
| List devices | Devices already bound to the user, plus online status | Licensed merchant | Devices |
| Update device | Change name, description, orientation, auto-OTA, and similar fields | Licensed merchant | Devices |
| Unbind device | Remove the frame from that user | Licensed merchant | Devices |
| Publish image | Push one still image to a device (file or image URL). The frame fetches and displays it when online | Licensed merchant | Publish |
| Play progress | Ask whether that publish is processing, succeeded, or failed | Licensed merchant | Publish |
Call the API with the merchant credentials apiKey / apiSecret. Use your own user id as externalUserId. Device protocol and cloud scheduling stay on the platform.
Full request preview (password-gated; a key is issued after you register as a merchant at InkJoy):
Device Setup SDK
| Capability | What it does | Availability | Detail |
|---|---|---|---|
| Discover | Bluetooth scan for nearby InkJoy frames | Android merchant App | SDK |
| Join Wi-Fi | Send the user’s Wi-Fi to the frame so it joins the InkJoy cloud | Android merchant App | SDK |
| Bind | Bind the frame to the merchant user (externalUserId) after setup | Android merchant App | SDK |
Initialize the SDK with the same apiKey / apiSecret. Guide the user: scan → enter Wi-Fi → confirm. BLE, cloud checks, and bind stay inside the SDK.
How API and SDK work together
- Call create / update user, keep the
uid. - Run the SDK: scan, join Wi-Fi, bind.
- After that, use this API to list devices, edit them, publish images, and read play progress.
OpenAPI preview (not Merchant API)
| Capability | What it does | Availability | Detail |
|---|---|---|---|
| Consumer OpenAPI | A different HTTP surface you can try before becoming a merchant. Useful to see device list, crop, rotate, and publish | Public preview | OpenAPI preview |
| Web tool | Static HTML demo at openapi.inkjoyframe.com | Public preview | OpenAPI preview |
| 1200×1600 publish | That preview publish accepts only 1200×1600 PNG/JPG. Landscape art must be rotated first | Preview only | OpenAPI preview |
Do not treat OpenAPI paths or the 1200×1600 rule as the licensed Merchant API contract.