BE SMART - BUILD IT

Use the eyeson API and SDK's

eyeson API

Overview

Integrate eyeson into your own apps with our API and SDK’s.

  • The eyeson API is the foundation upon which all SDK’s, frameworks, UI components and libraries are built.
  • The eyeson API offers direct control of eyeson CLOUD MCU instances you can even compose video content in real-time.

How to get started

1. GET YOUR API KEY

Please contact us to receive your personal API key for your implementation.

2. ACCESS THE API

API endpoint: https://api.eyeson.team

For authorization send an HTTP header with

Authorization: YOUR_API_KEY

Responses will always contain an appropriate HTML status code plus a JSON object in the body.

“on demand” eyeson web UI instance

3. START AND JOIN EYESON ROOM

It’s incredibly easy to get started. All you need to do is implement a single request (see below). This request creates an eyeson MCU instance and provides you with a link to a reference web UI which can be used right away.

The eyeson API provides eyeson room features to all WebRTC and WebSocket capable clients. All communication with eyeson occurs over Secure HTTP and Secure WebSocket protocols.

POST /rooms

PARAMETERS:

id:  String (optional)
If you want to get a single user or a handful of users into a specific meeting room, you can define an arbitrary id here. If kept empty, a random id will be returned.

name:  String (optional)
If you want to give the room a readable name

user:  User (required)
The user object is described as follows:

id:  String (optional)
You can commit a custom user id in order to identify the user in further REST requests without the need of remembering the eyeson user id e.g. your internal user id, an e-mail address, phone number, etc. If kept empty, a random id will be assigned.

name: String (required)
Display name of the user

avatar: URL (optional)
Avatars will be displayed in the sidebar of our pre-defined user interface.

EXAMPLE RESPONSE:

links: {
  gui: "https://app.eyeson.team/?588a0d32f9c4860024f36f3"
  self: "..."
  websocket: "..."
},
ready: false,
room: {...},
team: {...},
user: {...}

Redirect your client to the URL given in the links.gui attribute, to use our pre-defined user interface.

curl EXAMPLE:

$ curl -X POST \
       -H "Authorization: YOUR_API_KEY" \
       -d "user[name]=Bob" \
       "https://api.eyeson.team/rooms"

4. GO FURTHER WITH SDK’S AND API (COMING SOON)

TEST

Test your integration with (by using) the predefined eyeson UI

BUILD

Build a totally customized UI and UX by using the SDK’s

INTEGRATE

Integrate eyeson features in your own mobile and web applications

USE

Use additional eyeson cloud MCU features, available via the API

API FUNCTIONS
(COMING SOON)

Our REST API allows you to build your individual video communication solutions.

MCU FEATURES

  • Inject live data sources into the MCU (live video, play video file, static image, static text)
  • Specify layers and positions/sizes for live data source injection
  • Use predefined video conference layouts
  • Enable/disable video for participants connected to MCU
  • Add/remove audio/video sources (Moderator features)
  • Show selected sources in fullscreen mode on MCU
  • Connect external video sources (e.g. IP CAMS)
  • Connect MCU to CDN networks for broadcasting
  • Connect phone lines to your MCU
  • Trigger and manage recordings on your MCU

ADDITIONAL EYESON CORE FEATURES

  • Synchronized slide presentation / realtime slide image distribution
  • Feeds & Messaging
  • Upload / download / documents

We provide an API for real-time data synchronization. The RT API is a modern WebSocket based API providing you with a real time stream of events and enabling you to build a powerful UI in combination with our JavaScript libraries, SDK’s and REST API.

FRAMEWORK & SDK
(COMING SOON)

Connect and control an eyeson room session including the cloud MCU

WEB FRAMEWORK

The Web framework is built with the eyeson JavaScript library and React and can be integrated as a website component. It is designed with accessibility in mind and implements controls for screen capturing, chat, document presentation, and managing audio and video input and output devices. The JavaScript library is provided to easily connect to eyeson room with cloud MCU in modern browsers.

  • SIMPLE BUT POWERFUL

    The high level abstractions allow for easy control of video and audio streams, chat, screen capturing, document presentation and hardware device handling.

  • LIGHTWEIGHT

    A simple interface for managing complex workflows and a small number of external dependencies keep the size and the potential compatibility risks small.

  • EVENT DRIVEN

    You are free to respond to any events occurring during the session and customize your user’s experiences with a convention based action system. Events can be managed in individual interface components or in a state-drive approach.

  • FRAMEWORK AGNOSTIC

    Using this event driven system, eyeson is seamlessly integrated with other JavaScript libraries and frameworks like AngularJS, React or Vue.js using individual event handling or libraries like Flux, NuclearJS or Redux.

iOS SDK

The example implementation is available to showcase the integration of the iOS SDK.

The SDK is available with CocoaBots, including eyeson specific mobile UI components, handling of SIP connections, WebRTC A/V and a controller library.

CONTACT US

Send us questions, inquiries, or feedback for eyeson &
stay updated about the newest API features or just request an API key.

Your Name (required)

Your Email (required)

Your Message (max. 250 characters)

Send me an API key
Keep me updated about new API features

I agree to the Privacy Policy of eyeson