API integration: complete one real task first

These guides are for developers. Keep a scoped API token on your own backend, complete one small path from resource query to user-visible result, then look up the exact module endpoint. Clients receive only scoped short-lived addresses or one-use tickets.

flowchart LR
    A[Your backend] -->|API Token + HTTPS| B[AKStream.Next API]
    B --> C[Devices / channels / recordings / RTC]
    B -->|Short-lived playback or join ticket| D[Your browser or app]
    D --> E[MediaServer]

Find APIs by business layer

Layer	Goal	Guide
Current update	Check the installed version and the operations it actually provides	Release notes, Capability boundaries
AI-assisted development	Use public APIs, RTC SDKs and all public documentation with AI	AI-assisted integration and customization
Connection and identity	Reach the service, authenticate, and create tokens	Call preparation, Authentication and errors
Business backend integration	Use an API token for live video, recordings, deletion, and RTC without WebUI sign-in	Five-minute path, 27-endpoint contract
System and operations	Inspect health, nodes, configuration, logs, and jobs	System, operations, and node APIs
Accounts and licensing	Manage users, roles, tokens, audit, and license limits	Sign-in, accounts, security, and licensing APIs
Unified resources	Work with devices, channels, streams, and controls	Device, channel, stream, and unified resource APIs
Recording	Schedule, search, play, download, clip, and merge	Recording, file, clip, and storage APIs
GB28181	Registration, catalog, live view, playback, and control	GB28181 APIs
ONVIF	Discovery, profiles, PTZ, imaging, and events	ONVIF APIs
Real-time collaboration	RTC/SFU rooms, participants, whiteboards, and recording	RTC admission/media/control API, recording/archive API
Recent channel picture	Query snapshots and deliver a scoped image	Periodic snapshot API

The bundled integration Skill contains the 1.0.0.169 public contract with 626 public operations covering business and management APIs. Use the matching assets and check the deployment version for fields and permissions. RTC SDK signatures come from the matching delivered types and sources.

Recommended integration order

Call /health to verify basic reachability.
Create a dedicated least-privilege API token; do not store a person's password in an application.
Verify identity and permissions with /api/v2/auth/me or a read-only business API.
Complete one small workflow, such as list channel, start preview, confirm stream state, and stop preview.
Treat writes as submit, keep the returned ID, then poll or subscribe until a final state.
Add batching, retries, and concurrency only after the single-item flow is reliable.

Boundaries

HTTP 200 or 202 may mean accepted, not completed by the camera, media node, or recording worker.
Internal, callback, and node-local APIs are not third-party extension points.
Keep long-lived tokens on your server. Browsers should receive only short sessions or one-time tickets.

Where exact fields come from

The plain-language pages help you select the correct API. The OpenAPI asset shipped with the deployed version defines exact fields, enums, request bodies, and response bodies. Postman assets are useful for integration tests. Generated SDKs still need application logic for final-state polling, files, WebSocket, SDP, timeouts, and retries.

Start with call preparation and the five-minute guide, then open the guide matching your task. For Web/H5, native mobile, or UniApp meetings, follow RTC SDK integration.