Across many industries and use cases, developers on the OpenTok platform are creating live video applications that enable life changing experiences. Whether it is doctor-patient care, online tutoring, high-touch customer service, team collaboration, social interactions, or interactive broadcasting, developers are bringing people together worldwide in ways that were not previously possible.
Our customers are building their businesses on the OpenTok Platform. To meet the needs of increasingly sophisticated applications we’re introducing additional server-side REST APIs that give developers more dynamic control over the OpenTok Platform — the Session Management and Account Management APIs.
Session Management API (available now, public beta)
Application code running on your application servers can use the Session Management API to listen to the events that occur within an OpenTok session and take action. Accessing these events on the application server, and responding to them, makes it easier to integrate OpenTok session activity with your application logic.
Prior to this, OpenTok events were only available on the client. This meant that building smarter applications with the OpenTok Platform required writing a distributed application across clients. Now, with the server-side Session Management API, developers can centralize their application logic for managing how their OpenTok sessions behave. This greatly simplifies development and extends application possibilities.
With the Session Management API, developers can now build business logic that:
- Dynamically monitors session events
- Manages the users allowed in a session
- Sends signals to users within a session
- Decides when a session should start and end
- Sets limits on how many connections can be in a session
- Tracks the length of a session
- Tracks overall application usage
The API makes all this possible through a simple session monitoring webhook. Once this callback URL is installed, the platform will call it when a relevant event occurs. As these events are received, your application can use the Session Management API to send application signals to specific users in a session or force actions such as disconnecting a specific user. Signals can include any JSON object allowing detailed communication to session participants. With this approach, applications can be made smarter – responding dynamically to user and connection conditions as they change in real-time within an OpenTok session, and centrally directing appropriate client behavior.
Account Management API (available April 2017)
Our Account Portal is the convenient go-to site for customers to manage their TokBox accounts and sub-projects. While this works well for most customers, there are cases where a more programmatic approach is required. For example, some of our partners develop live video applications for multiple customers and teams. This typically means they need to manage their engagements through multiple project keys. As their customer base grows, this becomes increasingly difficult to manage manually through the Account Portal. Other partners may have the need for very dynamic use of different projects or keys for periods of time for specific purposes or sub-groups.
The new Account Management API provides a programmatic way to manage accounts and projects that can be integrated into existing workflows and management/provisioning systems.
The Account Management API enables developers to:
- Create a new project within an account
- Update the status of a project
- Delete an existing project
- Get information about a specific project or all projects within an account
- Refresh the secret of an existing project
OpenTok Platform Roadmap for Live Video APIs
Over the next twelve months we plan to continue on our session and account manageability theme and add more server-side APIs to provide developers with increased dynamic control over the OpenTok platform. This will include additional session details for batch processing, video quality data and usage data. Stay tuned for more details.
Getting Started with Session Management
We first introduced Session Management at the end of 2016 with limited participation. Today, the full service is available in public-beta form to everyone who wants to use it. Information about the Session Management API webhook is available here, and session signaling is available here.
Our platform is your platform. Take control of OpenTok with our new Management APIs and build smarter, more dynamic applications. We look forward to seeing what you build and, as always, your feedback is welcome.