API

The routes

Except the GET /api/info, all routes need the security token to modify data and interact with redis. This token need to be inserted in as HTTP POST variable in json.

Route	Purpose
POST /api/tiledata/([a-zA-Z0-9_-]+)	GET or DELETE specific tile
POST /api/tileconfig/([a-zA-Z0-9_-]+)	Update config(named meta) of tile
POST /api/push	Update data of tile
POST /api/update	Update data & config of tile
GET /api/info	Get infos from tipboard server

Usage Exemple

/api/tiledata/([a-zA-Z0-9_-]+)

{
    "data": {
        "title": "Title",
        "description": "Description",
        "big-value": "42%",
        "lower-left-label": "my lower left-label",
        "upper-left-label": "my upper left-label",
        "upper-right-label": "my upper right-label",
        "lower-right-label": "my lower right-label"
    },
    "meta": {"big_value_color":"#4CAF50", "fading_background": true},
    "tile_template": template_name,
    "modified": "2020-01-01T00:00:42+02:00",
    "id": tile_id
}

/api/push

{
    "data": {
        "title": "Title",
        "description": "Description",
        "big-value": "42%",
        "lower-left-label": "my lower left-label",
        "upper-left-label": "my upper left-label",
        "upper-right-label": "my upper right-label",
        "lower-right-label": "my lower right-label"
    },
    "meta": {"big_value_color":"#4CAF50", "fading_background": true},
    "tile_template": template_name,
    "modified": "2020-01-01T00:00:42+02:00",
    "id": tile_id
}

/api/update

{
    "data": {
        "title": "Title",
        "description": "Description",
        "big-value": "42%",
        "lower-left-label": "my lower left-label",
        "upper-left-label": "my upper left-label",
        "upper-right-label": "my upper right-label",
        "lower-right-label": "my lower right-label"
    },
    "meta": {"big_value_color":"#4CAF50", "fading_background": true},
    "tile_template": template_name,
    "modified": "2020-01-01T00:00:42+02:00",
    "id": tile_id
}

How to push execution flow

Unsecured part of API

Will be remove on production release