Imou-OpenPlatform

Posted on Aug 25

Imou Open Platform FAQ for builders: integrate cameras and go live

#camera #automation

How do you integrate an Imou camera? Create an application on Imou Open Platform, bind the camera into the developer asset pool, obtain accessToken on your server (BFF), sync deviceId / channelId into your product, then play video through ImouPlayer (getKitToken + kitToken) or a cloud live URL (bindDeviceLive for HLS, createDeviceRtmpLive for RTMP). Your product keeps tenant, site, and role ACL. Imou delivers connectivity and streams.

Does Imou support live streaming? Yes. Imou Open Platform is built for cloud live video. The documented protocol family includes HLS / FLV / RTMP (match the OpenAPI to the client you actually run), plus ImouPlayer for plugin-free interactive web preview. PTZ, cloud playback, and two-way talk are device- and package-dependent—gate those controls; do not promise them on every SKU.

Product overview: Video Monitoring.

Why builders ask both questions together

“Integrate the camera” without a live path is inventory plumbing. “Live streaming” without binding and server tokens is a demo that dies in production. The same four objects show up in every working stack: an application (appId / appSecret), a bound device, a server accessToken, and a client play credential (kitToken or a gated live URL). Mix those objects and you get black screens, leaked secrets, or “the camera works in the consumer app but not in my SaaS.”

This FAQ is brand-forward and technical: it tells you what Imou Open Platform is for, and the minimum path to a first live frame in your UI.

Combined minimal path

1. Register + create app          → appId / appSecret (server secrets only)
2. Bind camera to developer pool  → API-visible deviceId / channelId
3. BFF: accessToken               → OpenAPI admin auth (cache on server)
4. BFF: authorize end user        → YOUR ACL (tenant / site / role / camera)
5. Play:
     a) getKitToken → kitToken → ImouPlayer   (interactive web)
     b) bindDeviceLive → HLS URL              (custom HLS player)
     c) createDeviceRtmpLive → RTMP           (media pipeline)

If you only remember one rule: accessToken never enters the browser player. ImouPlayer consumes kitToken.

Dual FAQ

Q1. How to integrate an Imou camera?

Treat integration as product + API, not as “paste a stream into <video>.”

Layer	You own	Imou Open Platform owns
Identity & ACL	Tenant, site, role, who may watch	Developer `appId` / `accessToken`
Inventory	Store `deviceId` / `channelId` on your sites	Bind pool + list APIs (e.g. `listDeviceDetailsByPage`)
Live	BFF mint of `kitToken` or live URL after ACL	Cloud live + ImouPlayer / HLS / RTMP
Controls	Show/hide PTZ, playback, talk in UI	Device capability + subscribed services

Steps that actually ship:

Create the application at open.imoulife.com. Store appSecret in a secrets manager. Never commit it, never ship it in a SPA or mobile binary.
Bind the camera into the Open Platform developer asset pool. A device that only appears in a consumer account is not automatically API-visible. Binding is the difference between “we bought cameras” and “OpenAPI can list and play them.”
Mint accessToken on the BFF using the documented accessToken flow. Cache it server-side. This token authenticates OpenAPI. It is not a player token.
Sync inventory into your model. Paginated device queries (pageSize typically 1–50) are enough to attach cameras to sites. Your SaaS remains the source of truth for “this camera belongs to Site A, Tenant X.”
Play on demand. When a signed-in user opens Live, authorize first, then mint kitToken or a live URL. Destroy players on route change. Prefer streamId = 1 (SD) for grids; streamId = 0 (HD) for a single focus tile.

Native mobile uses OpenSDK; the same ACL-and-BFF idea applies—do not embed appSecret in the app.

Q2. Does Imou support live streaming?

Yes. Live is a first-class Open Platform surface, not an afterthought. Choose the API by product surface, not by whichever method you found first in search.

Surface	What to call	Client
Interactive web (preview + Light App controls)	`getKitToken` + ImouPlayer	Browser; `kitToken` only
Standard HLS URL	`bindDeviceLive`	Your HLS player; treat URL as sensitive
RTMP pipeline	`createDeviceRtmpLive`	Encoder / media server / RTMP consumer
OpenAPI admin	`accessToken`	Server only

Cloud live messaging on the platform refers to common protocol families (HLS / FLV / RTMP) depending on the interface and device. Match the exact OpenAPI method to the protocol your client consumes. Do not invent a GB-style national-standard ingest path; this international stack is OpenAPI + SDK + cloud live.

Live-view quota is real. Bursting 16 HD tiles at once is a product bug, not a “platform is down” incident. Plan concurrency, default SD, and check My Resources when sessions fail after a spike.

PTZ, playback, and two-way talk are not implied by “live works.” Live preview can succeed on a model that has no talk channel or no PTZ. Gate the UI after you verify capability for that deviceId.

Tables you can keep in the repo

Play credential vs admin credential

Token	Where it lives	Used for	If you swap them
`accessToken`	BFF / secrets	OpenAPI (`getKitToken`, `bindDeviceLive`, inventory, …)	Black screen if stuffed into ImouPlayer
`kitToken`	Short-lived; minted after ACL	ImouPlayer init	Player stays dark if you skip mint and pass admin token
Live URL (HLS/RTMP)	Returned to authorized clients only	Custom players / pipelines	Leak = unauthorized watch

Cache kitToken on the BFF on the order of ~1 hour; documented validity is about ~2 hours. Refresh before expiry on long Live tabs.

Integration anti-patterns

Anti-pattern	What happens	Fix
`accessToken` in ImouPlayer	Black screen / auth errors	`getKitToken` → `kitToken`
Unbound device	Empty list, live APIs fail	Bind into developer pool
ACL after mint	Cross-tenant views	Authorize before OpenAPI play calls
Prefetch all live URLs on list page	Quota burn, stale 404s	Mint when the tile is visible
Promise PTZ/talk on every camera	Support tickets	Capability-gate the chrome

Minimal BFF sketch (illustrative)

POST /api/live-session  { deviceId, channelId }
  → session + ACL (403 if denied)
  → accessToken (cached)
  → getKitToken(...)
  → { kitToken, expiresAt, streamId }   // never accessToken

Web:

ImouPlayer.init({ kitToken, WasmLibPath, streamId: 1 })
destroy on unmount

HLS branch (same ACL):

bindDeviceLive(...) → HLS URL → your player

Align option names with the SDK version you download. JS reference: JavaScript development. Live methods: bindDeviceLive, custom live summary.

Limits (say them out loud)

Capabilities depend on device model and subscribed services. No invented SKUs or SLA Mbps here.
kitToken ≠ accessToken. This is the number-one builder bug.
Live URLs are credentials. Log them like secrets.
Multi-camera walls need a slot model (visible tiles only), not “open every HD player.”
Consumer-app deep links are not a SaaS integration.

Imou Open Platform is focused on cloud video and AIoT: OpenAPI, SDKs, and low-code components so vendors and developers can ship video inside their own products instead of bouncing users to a consumer app. Register, create an application, and start from the video monitoring overview: https://open.imoulife.com · Video Monitoring.

DEV Community