Learning paths

Get one picture or one successful API call first. Then follow the guide that matches your product.

Choose by goal

Compare protocols and latency in Choose an integration mode.

Prerequisites shared by every path

1. Register and create an app. Copy AppId and AppSecret from Create an app. Never put AppSecret in a client package.
2. Bind at least one camera to the developer account. A device that only appears in the consumer app is invisible to OpenAPI. See Add a device.
3. Server calls use https://openapi-[DataCenter].easy4ip.com. Read the data center in Console · My information.
4. Do not give app users the administrator accessToken. Use Sub-accounts and policies.

Server API path

1. First API call: sign the request body, call accessToken, then Paged device detail.
2. Create or list a live address from Device live.
3. Device settings and events go through Capability usage, not the old things-model OpenAPI.

Mobile SDK path

1. Download Android or iOS OpenSDK from Downloads.
2. Follow SDK first preview, then Build a mobile app.
3. Provisioning, init, preview, talk, and image decryption stay in the client SDK. Account and list APIs stay on your server.

Light app path

1. Download Web Video SDK from Downloads.
2. Follow Light-app first preview. Mint kitToken on the server only.
3. Full player parameters are in JavaScript development.

Cloud live path

1. Confirm the camera is bound, then open Console · Live service for an H5 page, or call bindDeviceLive / createDeviceRtmpLive.
2. Walk through Console first live view and Cloud live from an AppId.
3. HLS notes: Cloud live (HLS).

Home Assistant path

The book already documents this integration. Install the component from Downloads or GitHub, then follow Home Assistant integration. Use the same AppId / AppSecret and the API domain of your data center.