Page tree
Skip to end of metadata
Go to start of metadata

Getting Started with Skylink API

Skylink REST API is provided for developers who wants to integrate and build on top of the Skylink platform to access, configure, and control their application contexts via the Skylink API server.

These APIs provides access to resouces using URI API calls by making HTTP requests and receiving the response in JSON. Standard HTTP methods like GETPUTPOST and DELETE are provided for the relevant features. You may access the REST API using any language as it's built on open standards.

Before making any API requests to access the resources, you will require to authenticate the user first with this Login API. You may check for any existing session with the Logstatus API.

The endpoint URI is


Javascript Example

Here's an example to authenticate a user via the REST API.

Example Code
var rest_api = 'rest/login/';
var params = {
  username: 'myusername',
  password: 'mypassword'
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function(){
  if (xhr.readyState == 4 && xhr.status == 200){
    var result = JSON.parse(xhr.responseText);
    // do what you want here
};, '' + rest_api, false);
xhr.withCredentials = true;
xhr.setRequestHeader('Content-type', 'application/json');
if (params) {
  xhr.send(JSON.stringify(params) || null);
} else {

PHP Example

To be added in the future.

Python Example

To be added in the future.

cURL Example

To be added in the future.


List of APIs


Application Resources

Meeting (Persistent Room) Resources

Profile Resources

Usage Resources

Account Resources


  • No labels