documentation/71_web/4_aPI.md

API

If you want to integrate Kerberos.io into your own application, you're at the right place! The Kerberos.io web interface comes with a RESTfull API, that allows you to get and modify data delivered by the Kerberos.io framework.

• Reboot the system
• Disable Kerberos.io
• Health check
• Enable or disable output devices
• ..

Authentication

To use the RESTfull API of your Kerberos.io instance you need to define an Authorization header with each request. We use Basic Authentication to secure the different endpoints.

"Authorization": "Basic root:root"

An example with Python looks like this.

import requests
import json
import base64

url = "http://ip-of-pi/api/v1/condition/enabled"
username = "user"
password = "passw"
basicAuth = base64.b64encode('%s:%s' % (username, password))
headers = {"Authorization": "Basic " + basicAuth, "Content-Type": "application/json"}

data = '{"active": "true"}'

#Call REST API
response = requests.put(url, data=data, headers=headers)

print(response.text)

If you're using the wrong credentials, Kerberos.io will return following error message.

Invalid credentials.

Endpoints

All endpoints are prefixed with api/v[version #]/, in which the last part defines the API version number. Below you will find all the available endpoints with there signature and response. Note that when you call an endpoint which doesn't exists, Kerberos.io will throw an 404.

{
	"error": "API method does not exists"
}

API version 1

A list of all API methods available for version 1.

GET api/v1/name

**Description**

Retrieve the name of your instance.

Response

{
	"name": "frontdoor"
}

PUT api/v1/name

**Description**

Change the name of your instance.

Data

{
	"name": "frontdoor-changed"
}

Response

Similar to GET api/v1/name.

GET api/v1/condition/enabled

**Description**

Check if enabled or disabled.

Response

{
 	"active": "true",
 	"delay": "5000"
}

PUT api/v1/condition/enabled

**Description**

Activate or disable the system

Data

{
 	"active": "false"
}

Response

Similar to GET api/v1/condition/enabled.

GET api/v1/system/health

**Description**

Check if the machinery is running (the stream is connected).

Response

{
 	"status": "false"
}

POST api/v1/system/reboot

**Description**

Restart the system.

POST api/v1/system/shutdown

**Description**

Shutdown the system.