martinberlin/cale-integrations

60/99 CALE api

Closed this issue · 3 comments

The idea is to offer a very simple endpoint outside the Website/Backend infrastructure that will offer a very fast and reliable endpoint to respond from IoT requests.

For now I'm not going to make a new repository for this since it can perfectly live in the Screenshot tool, like:
img.cale.es/api

First method will be: #21 Service times

img.cale.es/api/times

The request will contain:
username
screen (id)

And it will respond with boolean:
0
1

On 1 the device will render the Eink screen and on 0 will sleep another loop.
But the API is intended to do more than this. Backend should generate an API key and a QR Code so we can link the https://github.com/martinberlin/cale-app
Then it will also have methods for:
screen_list
screen_json_config

So as a user we avoid:

  1. Typing a long API key in the mobile device
  2. Copying and pasting operations from Browser to Android app

That are always mostly a pain

Service times is already live

On hold. Document this using #28

They are not any more APIs planned at the moment. New ones will be made by voting and suggestions by CALE users using this Issue tracker in Github.
We thank you for your involvement in the project and for the supporters that are paying since months the AWS Server costs