mirror of https://codeberg.org/timelimit/timelimit-server.git synced 2025-10-03 09:49:32 +02:00

History

Jonas Lochmann e46f5bea3f Add account deletion API		2023-04-09 14:30:26 +02:00
..
admin.md	Add new purchase API	2022-09-26 02:00:00 +02:00
auth.md	Show the source device in login code mails	2021-12-30 10:27:49 +01:00
child.md	Send ClientDataStatus after registering new device	2022-11-28 01:00:00 +01:00
parent.md	Add account deletion API	2023-04-09 14:30:26 +02:00
purchase.md	Send google play public key during /purchase/can-do-purchase	2020-06-08 02:00:00 +02:00
README.md	Add basically API documentation	2020-05-04 02:00:00 +02:00
sync.md	Add support for child users adding limits themself	2020-08-03 02:00:00 +02:00
websocket.md	Add basically API documentation	2020-05-04 02:00:00 +02:00

TimeLimit Server API documentation

The client communicates with the server using HTTP(S) requests and a socket.io websocket connection.

All requests bodies (if any) and responses are encoded as JSON if not said otherwise.

/admin

This endpoint is for the server administrator. Its interface is described at admin.md.

This endpoint is used for the user authentication. Its interface is described at auth.md.

This endpoint is used for by devices which are used by a child. Its interface is described at child.md.

This endpoint is used by devices which are used by a parent. Its interface is described at parent.md.

This endpoint is used for handling purchases from the client. Its interface is described at purchase.md.

This endpoint is used by clients for syncing. Its interface is described at sync.md.

This endpoint returns the current time of the server as a Unix timestamp in milliseconds. This does not need any authentication.

The response is a object with the property ms whose value is the timestamp as number.

Example response: {"ms":1578311020747}

The websocket is used for real time notifications from the server to the client. The protocol is described at websocket.md.