niansa/commsy-rest
1
0
Fork 0
mirror of https://gitlab.com/niansa/commsy-rest.git synced 2025-03-06 20:48:27 +01:00
Code Releases Activity

Update README.txt

Browse source
This commit is contained in:
niansa 2020-09-16 17:49:48 +00:00
parent 2d96b90dcb
commit 2a19e2c5a0
2 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md Normal file
View file

@ -0,0 +1,15 @@
### Commsy REST API
Provides a REST API to commsy servers via libcommsy
## Example server
`https://commsyapi.home.tuxifan.cf`
Endpoints:
# `/fetchList`
GET parameters:
* url: URL to the commsy server (startpage)
* sid: SID to authenticate with
* room: room to load
* startId: ID before the first ID to list (optional, default: start with first post)
* maxPosts: maximum amount of posts to load

1
README.txt
View file

@ -1 +0,0 @@
https://commsyapi.home.tuxifan.cf/fetchList?url=<url>&sid=<sid>&room=<room>&startId=[ID before the first ID to list]&maxPosts=[maximum amount of posts to load]