Skip to content

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 ​

CapabilityWhat it doesAvailabilityDetail
Create / update userRegister or update a merchant user with your externalUserId before setup. The platform returns its uid. The SDK cannot bind a frame until this existsLicensed merchantUsers
Query userLook up that user by externalUserIdLicensed merchantUsers
List devicesDevices already bound to the user, plus online statusLicensed merchantDevices
Update deviceChange name, description, orientation, auto-OTA, and similar fieldsLicensed merchantDevices
Unbind deviceRemove the frame from that userLicensed merchantDevices
Publish imagePush one still image to a device (file or image URL). The frame fetches and displays it when onlineLicensed merchantPublish
Play progressAsk whether that publish is processing, succeeded, or failedLicensed merchantPublish

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):

Apifox Merchant API preview

Device Setup SDK ​

CapabilityWhat it doesAvailabilityDetail
DiscoverBluetooth scan for nearby InkJoy framesAndroid merchant AppSDK
Join Wi-FiSend the user’s Wi-Fi to the frame so it joins the InkJoy cloudAndroid merchant AppSDK
BindBind the frame to the merchant user (externalUserId) after setupAndroid merchant AppSDK

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 ​

  1. Call create / update user, keep the uid.
  2. Run the SDK: scan, join Wi-Fi, bind.
  3. After that, use this API to list devices, edit them, publish images, and read play progress.

OpenAPI preview (not Merchant API) ​

CapabilityWhat it doesAvailabilityDetail
Consumer OpenAPIA different HTTP surface you can try before becoming a merchant. Useful to see device list, crop, rotate, and publishPublic previewOpenAPI preview
Web toolStatic HTML demo at openapi.inkjoyframe.comPublic previewOpenAPI preview
1200×1600 publishThat preview publish accepts only 1200×1600 PNG/JPG. Landscape art must be rotated firstPreview onlyOpenAPI preview

Do not treat OpenAPI paths or the 1200×1600 rule as the licensed Merchant API contract.

ePaper Frame API Docs