IT-Syndikat/ITSynOpen
Archived
14
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
This repository has been archived on 2024-02-16. You can view files and clone it, but cannot push or open issues or pull requests.
ITSynOpen/server/README.md
Xiretza 8c2a309887 server: update README
2022-08-16 21:25:18 +02:00

966 B
Raw Blame History

SpaceAPI endpoints

The API is currently available under https://spaceapi.it-syndikat.org/api/. The following endpoints exist:

  • GET status.php: the current space status in SpaceAPI format, registered in the SpaceAPI directory
  • GET status-s.php: returns true if space is open, false if closed. Called by discourse theme and serendipity.
  • POST update.php: updates the current open status, called by the wood box with two fat buttons ("2fb").
  • POST ping.php: requests a "spaceping". Called by the matrix bot.
  • POST ping-get.php: returns true if a ping request is pending, then resets the request. Called by 2fb.

All endpoints except for status[-s].php require an API key to be passed via the apikey= GET parameter. These API keys are defined in config.inc.php, see config.inc.php.example for an example.