frankenapi/apiDoc.txt
2022-09-08 09:18:04 +02:00

139 lines
1.9 KiB
Plaintext

Frankenbot API Endpoint
POST [SYS ONLY] /stats/user
creates stats for a user inside the stats database
{
serverid,
userid,
permtoken,
created
}
PUT [SYS ONLY] /stats/user
Updates a Users stats object if present
{
serverid,
userid,
permtoken,
newxpamount,
newlevelamount,
newmessageamount
}
GET /stats/user
fetches a users stats object if present
{
serverid,
userid,
permtoken,
}
GET /stats/server
gets all users registered for a server
{
serverid,
permtoken
}
POST [SYS ONLY] /server/settings/general
creates settings for a server
{
serverid,
permtoken,
servername,
created
}
PUT [SYS ONLY] /server/settings/general
Updates settings for a specified server
{
serverid,
permtoken,
commiterid,
logchannel,
spamchanne,
greetingchannel,
announceChannel,
logger,
stats,
spamprevention,
worldfilter,
apitoggle,
statspage,
statsmode,
twitchAnnounce,
twitterAnnounce,
music,
moderation
}
POST [SYS-WEB ONLY] /server/settings/social
adds a new socialmedia account to a server for announcements
{
serverid,
permtoken,
commiterid,
socialtype,
identificator
}
GET [SYS ONLY] /server/settings/social
gets the social media entries of a server
{
serverid,
permtoken
}
DELETE [SYS-WEB ONLY] /server/settings/social
removes a socialmedia account from a server
{
serverid,
permtoken,
commiterid,
identificator
}
POST [SYS ONLY] /server/settings/filter
adds another forbiden word to the servers filter
{
serverid,
permtoken,
commiterid,
word
}
POST [SYSONLY] /server/settings/punishments
creates a new automated punishment
{
serverid,
permtoken,
commiterid,
warnamount,
punishtype,
duration,
reason
}
DELETE [SYS ONLY] /server/settings/punishments
removes an automated punishment
{
serverid,
permtoken,
commiterid,
warnamounts
}
POST [SYS ONLY] /server/settings/punishments
adds a punishment to the database
{
serverid,
targetid,
commiterid,
permtoken,
type,
duration,
reason
}