Skip to content

Getting started ​

Integration order ​

  1. Register as a merchant with InkJoy and receive apiKey / apiSecret.
  2. Call create / update user with your externalUserId. Keep the platform uid.
  3. In your Android App, initialize Device Setup SDK with the same credentials.
  4. Walk the user through scan → Wi-Fi → confirm. The SDK binds the frame to that user.
  5. From your server, list devices, publish a still, then query play progress.
your user id ──► create/update user ──► uid
                      │
                      ▼
              Device Setup SDK
              scan / Wi-Fi / bind
                      │
                      ▼
              Merchant API
              list / update / unbind / publish / progress

Field-level contracts ​

This guide does not invent URL paths or JSON bodies. After you are a merchant, open the password-gated preview (the key is issued with the account):

Apifox Merchant API preview

Before you have a merchant account ​

You can still feel the platform with the consumer OpenAPI and the HTML web tool. That path is documented separately and is not Merchant API.

See OpenAPI preview.

ePaper Frame API Docs