Sneed-Group/harmonychat-api-whitepaperish
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update 'README.md'

Browse source
This commit is contained in:
nodemixaholic 2024-03-07 19:40:07 +00:00
parent fd450495a6
commit bd2c77fbb6
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -29,7 +29,10 @@ https://example.com/harmonychat-api/v1 (so the BasePath is "/harmonychat-api/v1"
* /common-details/get?detailType="friendsOrChannels"&unameOrServerID="tux"&passwd="usersPassword" - Get list of channels for server or friends. Passwd is not needed for the case of listing server channels, as demonstrated here, but *is* needed for listing a persons friends with friendship IDs next to them (Example `tux - ${randomizedFriendshipID}`).
* /common-details/create?detailType="friendsOrChannels"&serverIdOrUname="tux"&selfPasswd="usersPassword"&friendUsernameOrChannelName="penny" - creates a random friendship/channel ID (friendship and channel IDs are interchangeable in the API), freindship/channel same for the friend username and self username if "friendUsernameOrChannelName" is a person's username. if it's actually a channel name, add the channel named with the nammed passed through "friendUsernameOrChannelName" to the server "serverIdOrUname" but only if it's a valid server and the user credentials match those of the a server admin.
/common-details/add?detailType="server"&serverId="tux's igloo"&uname="penny"&selfPasswd="usersPassword"
### Server (guild) creation
* /server/create?serverName="tux's igloo"&uname="tux"&passwd="usersPassword" - Creates server with random server ID and server name of the serverName variable, sets the first admin in the admins dictionary to a username (tux) and a password (usersPassword, as always this should be encoded on the server side, replacing usersPassword with the deencoded password!)
### Server (guild) creation and administration.
* /server/create?serverName="tux's igloo"&uname="tux"&passwd="usersPassword" - Creates server with random server ID and server name of the serverName variable, sets the first admin in the admins dictionary to a username (tux) and a password (usersPassword, as always this should be encoded on the server side, replacing usersPassword with the deencoded password!)
* /server/manage?taskName="makeAdmin"&targetAdminUname="penny"&serverName="tux's igloo"&selfUname="tux"&passwd="usersPassword"