Documentation

API Overview

Video.io API is organized around REST. The API accepts form-encoded and JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. It also provides MQTT notifications with data changes for more convenient handling of creation, update and deletion of videos.

Base API URL:

https://api.video.io/v1

Authorization

All requests to API should be authorized, to do so you should use standard authorization HTTP header. There are 2 different level of authorization and each of them has slightly different format of authorization header value:

Example of application level of authorization request:

curl --request GET \
  --url https://api.video.io/v1/videos \
  --header 'accept: application/json; charset=utf-8' \
  --header 'authorization: App token=YOUR_SECRET_TOKEN'
var request = require('request');

var options = {
  method: 'GET',
  url: 'https://api.video.io/v1/videos',
  headers: {
    accept: 'application/json; charset=utf-8',
    authorization: 'App token=YOUR_SECRET_TOKEN'
  }};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.video.io/v1/videos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json; charset=utf-8'
request["authorization"] = 'App token=YOUR_SECRET_TOKEN'
response = http.request(request)
puts response.read_body
import requests

url = "https://api.video.io/v1/videos"

headers = {
  'accept': 'application/json; charset=utf-8',
  'authorization': 'App token=YOUR_SECRET_TOKEN'
}
response = requests.request("GET", url, headers=headers)

print(response.text)

Errors

If for some reason your request cannot be fulfilled, the server with send you response with HTTP status code:

and error message in the following format:

{
  "error": "ERROR_MESSAGE"
}