ReST API

There will be built-in support for a ReST API allowing for connections in mobile apps or in other use cases. In order to use the API, you first need to get access to an API Key. At the moment, the only way to get an API key is to add one manually in the config.

General Usage

API Token

All API requests will have to supply the API key somewhere in the request:

For GET Requests, add the key GET parameter.

/api/apiStuff?key='your-api-key'

For POST Requests, add the key header

Errors

All requests will return either success, or failure. On failure, a return code will be given, as well as context for more information.

The return code is used to let the program know what happened, and the context is used to let the user know what happened.

{
    "success": false,
    "error": 0,
    "context": "Some context for the error"
}

Weather API

Current Weather

/api/weather/now

Type:GET

Get the current weather

Returns:A json object containing all the weather data

{
    "success": true,
    "weather": {
        "time": "The time when the data was recorded",
        "data": {
            "tempurature": {
                "value": 27.4,
                "type": "c"
            }
        }
    }
}

Weather history

/api/weather/history(date: str, days: int, hours: int, minutes: int)

Type:GET

Retreive a set of data from a day during a time period.

Parameters:

• date –

  The date to start retreiving weather

  If omitted, the current day will be used.

• days – The number of days to look for data
• hours – The number of hours to look for data
• minutes – The number of minutes to look for data

The default time frame will be 1 day if no time frame is given

Examples:

Get the history of the current day

/api/weather/history

Get the history of the day August 28, 2020

/api/weather/history?date='2020-8-28'

Get the history of the past two days

/api/weather/history?days=2

Get the history of the day August 28, 2020 and the day before

/api/weather/history?date='2020-8-28'&days=2

Returns:

{
    "success": true,
    "history": [
        {
            "time": "The time when the data was recorded",
            "data": {
                "tempurature": {
                    "value": 27.4,
                    "type": "c"
                }
            }
        }
    ]
}

Settings

Get

/api/settings/get(group: str)

Type:GET Permissions:Settings

Get a list of the settings

Parameters:group – The optional groupname. If no group is given, all groups are returned Returns:

{
    "success": true,
    "settings": {}
}

Change

/api/settings/change(settings: object)

Type:POST Permissions:Settings

Change a setting’s value

Parameters:settings –

An object of key-value pair setings

{
    "group:setting-name": "Whatever-Settings-Object Required"
}

Returns:

{
    "success": true
}

Apply

/api/settings/apply

Type:GET Permissions:Settings

Apply the changed settings to disk. This may require a restart of the server to take effect.

Returns:

{
    "success": true,
    "restart_required": true
}