Skip to content

Welcome to Spoiler interface documentation

Introduction

Spoiler interface is an IOT platform and mainly focuses on an API that allows you to perform interactions such as add, retrieve and modification of data via the API using JSON web appication.

Interacting with the interface has the following advantages:

It is based on JSON (JavaScript Object Notation) Web Application Services and HTTPS, therefore it is accessible from any platform or operating system, and all server and client communications are secure. The API provides validation and checks for all the configured devices, and the history can be easily accessed. Spoiler interface API can be configured to run on the local network using docker containers for organisations that require strict access to the data.

Spoiler interface gives the user the ability to insert, update, select and delete data for connected devices. The devices are linked to a specific account which has its own login credentials. Every user account/email has to be verified before being granted access to the API and dashboard.

All API requests that contain date and time attributes use the epoch time seconds. In some operations/calls, the time can or will be generated by the the interface and this time will be in epoch seconds. It is up to the user to offset this time to whatever is applicable to them.

Security

Connection to the API is provided via HTTPS. Authentication is done using the user's credentials and the token that is provided after authorization. We advise that the token property that is received during authorization be used for any subsequent request.

API servers