Overview
InkJoy Merchant API is the HTTP interface for a merchant’s own business system or App. It is used together with InkJoy Device Setup SDK.
- The SDK puts a frame on Wi-Fi and binds it to your user.
- This API then lets your server or App manage users, list devices, and publish images.
You do not implement the device protocol. Cloud scheduling stays on the platform.
This site follows 基于 InkJoy API 的开发对接指南. The capability table is on Function Specs.
What the API covers
- Merchant users — register or update a user with your
externalUserIdbefore any setup. The SDK cannot bind a frame until that user exists. - Bound devices — list devices for that user and their online state; change name and similar fields; unbind when needed.
- Publish — push one still image to a device (file or URL). Then read play progress: processing / success / failure.
What you supply
- Merchant credentials:
apiKey/apiSecret - Your own user id as
externalUserId - Setup through the SDK; user, device, unbind, and publish through this API
Not this API
OpenAPI preview (openapi.inkjoyframe.com) is a different HTTP surface you can try before you become a merchant. Do not copy its paths or the 1200×1600 rule into a Merchant API integration.
Operators who want a finished console, not an API, should use CMS.