Introduction
Start a meeting
The most basic action, to start a meeting, does only require a single request to our service. Immediately a conference room is prepared and available to be joined. The service provides a secure access token that authenticates your user. In order to use eyeson as quickly as possible, you can simply forward your user to the default eyeson web UI. No need for your users to install any additional software.
Get together
To ensure your participants end up in the same room you can use the unique identifier argument (id). This also comes in handy when you want to keep track of the meetings that took place as well as any recordings that have happened. We provide Webhooks to do so.
Register your service endpoint once and all meeting and recording information of any future sessions will be sent there. Select custom identifiers for your rooms and users, so you can fully integrate any details in your existing platform.
Default user interface
To get started quickly we provide a default web user interface. There are plenty of options to adapt the web UI, you can disable recordings, snapshots, and other features by providing a certain configuration starting the room. However, if the provided options do not fit your needs you can easily build your own user interface.
We do provide a JavaScript package that helps you get started, hides away the tricky parts and additionally provides you with many helpers that save time and money like a device manager or a feature detector.
Using a custom UI you have no limits on controlling the look and feel of your video sessions. Additionally, it can be integrated seamlessly into any existing platform.
Get started with your project
To get started with your project create your own API key. We provide a free plan that includes some time credit to test our API service. Check pricing and plans to see if it fits your business or contact our sales team to find you a custom plan.
Some example applications can be found at our official GitHub account where we also host documentation and packages for several development environments. No worries if your programming language of choice is not included, the eyeson API is based on widely used web standards. Any action can be implemented in only a few lines of code.
The GitHub repositories are also the number one place to reach out for help. Our development team will be happy to help.