API reference

Parameter tables stay on each method page. This page only groups the current overseas tree.

Before calling an API

1. Copy AppId / AppSecret from Create an app.
2. Read the data center in Console · My information.
3. Host: https://openapi-[DataCenter].easy4ip.com.
4. Walk through First API call.

Public conventions

• Hub: Development specification
• Request conventions
• Signature
• accessToken
• Return codes
• Interface call limits
• Request example
• Version and change notes

Account and OAuth

Account APIs · OAuth authorization · Resource pool quota

Device APIs

Flat methods on Device APIs: bind / unbind, V2 device.detail.* / device.status.get / device.bindstate.get / device.prebind.get, leftover list methods, snapshots, and timezone helpers.

Settings and events after bind: Capability usage.

Live

Device live — bindDeviceLive, RTMP/FLV/HLS helpers, plans, and status.

Cloud storage and cloud recordings

Cloud storage. Package ids: Cloud storage packages.

Push configuration

Push configuration. Callbacks only — no message-channel pull. Guide: Receive device messages.

Legacy APIs

Legacy APIs — methods still called as POST /openapi/{method} (including door APIs). Not the new-integration default.