Video API: integrate real-time communication programmatically
Short answer
A video API exposes programmatically (REST, WebSocket, SDK) the functions of a business video platform: room creation, token generation, participant management, event webhooks, and metrics. It embeds real-time communication into a CRM, customer portal, or existing business application.
What operations does a video API cover?
| Operation | Description |
|---|---|
| Create a room | Room ID, configuration (max participants, recording) |
| Generate a token | Signed temporary access for a participant |
| List participants | Real-time session state |
| Webhooks | join/leave/recording/end events |
| Metrics | Network quality, duration, bitrate |
Video API vs SDK vs iframe
| Approach | Complexity | UX control | Use case |
|---|---|---|---|
| REST API only | Low | Backend only | Orchestration, auto links |
| JavaScript SDK | Medium | Full | Custom portal |
| Embedded iframe | Low | Limited | Fast integration |
Typical API architecture
Business application (CRM, portal)
↕ REST API (HTTPS)
Video API server
↕ Signaling (WSS)
WebRTC infrastructure (SFU, TURN)
↕ Webhooks
Business application (events)
The API does not carry video streams: it orchestrates the session. Streams flow through WebRTC and the SFU.
API security and authentication
- JWT tokens: temporary access, scopes (publish, subscribe, moderate);
- API keys: server-to-server authentication;
- SSO / OIDC: enterprise identity federation;
- Rate limiting: abuse protection.
Video API and sovereignty
The API runs on the same infrastructure as SFU/TURN. For sovereignty:
- API hosted in France;
- Logs and webhooks in the EU zone;
- No transit through unmanaged US API gateways.
Integration examples
- Customer portal: “Start a video session” button → API creates room + token → iframe;
- CRM: “session ended” webhook → customer record update;
- Calendar: booked slot → auto video link (see mes-rdv.fr).
Full business use cases live on dedicated products, not leagora.io.
How does Leagora expose its video API?
REST API for session management, webhooks, signed tokens. Integration with sovereign WebRTC infrastructure. Contact for technical documentation.
FAQ
Does the video API carry video streams?
No: it orchestrates sessions. Streams flow through WebRTC (SFU/TURN) directly between the browser and infrastructure.
Is a client SDK required?
Not mandatory: a link + token is enough for a simple journey. The SDK enables advanced UX control.
Is the API compatible with on-premise?
Yes: the API runs on the same infrastructure as the SFU, deployable in the customer datacenter.
How do you secure webhooks?
HMAC signature, HTTPS required, IP whitelist, retry with backoff.
Does a video API replace a public meeting solution API?
It replaces the programmatic layer of infrastructure you control — not a closed SaaS like the Zoom API.
Key takeaways
- Video API = programmatic orchestration of WebRTC sessions.
- REST + tokens + webhooks = standard SI integration.
- leagora.io = infrastructure hub; business products on satellite sites.