Hosted by Clewn.org, hosting funded by donations

Ripf protocol specifications

This is the RIPF protocol specification for people whishing to write software interacting with the RIPF services.

The RIPF basis concepts
1. Geolocated bulletin boards vocal message radio streams aimed at local news posting
2. Requirement for using the service
1. The server
2. The clients
  1. The desktop client
  2. The web client
3. The stations
The API for writing a client application

General note about API calls
The server provides three URL endpoints for various API purposes.
For the scope of this document we'll assume <server> is http://ripf.clewn.org.
For any API call, an HTTP GET parameter of name "action" is mandatory ; it defines which API command is to be processed by the server.
In any case, note the following :
- If the API was correctly reached, the HTTP response's mime-type will be set to text-plain. Any other mime-type (example : text/html) would mean the API was not reached (due to server downtime, maintenance...)
- The API endpoints will always reply to commands by a list of NEWLINE ("\n") separated list of items
- In cas of success of the passed command, the first line will always be <command> OK in uppercase, followed by the response body
- If the firts line differs from this, it means the API call could not be completed and then the response is probably some kind of textual information meant to be displayed to the user
1. <server>/api/
  1. action GET param set to list
  1. action GET param set to info
  2. param[] GET param
2. <server>/upload
  1. action GET param set to upload
  2. radio GET param
3. <server>/
© 2017 RIPF