RoWifi API
RoWifi’s API is based around a HTTPS/REST API for all operations.
Base URL
RoWifi has different versions of its API. You need to specify which version of the API you would like to use in your request path like https://api.rowifi.xyz/v{version}.
API Versions
| Version | Status |
|---|---|
| 2 | Active |
| 1 | Deprecated |
Authentication
Authenticating with the RoWifi API can be done only using the API tokens obtained from the Tokens page of the Dashboard. Authentication is performed with the Authorization HTTP header in the format Authorization: Bot TOKEN
Rate Limiting
All endpoints currently follow the 5 per second per IP/token rule. This may change in the future and an announcement will be made as such.
Routes
Get Member
GET /guilds/{guild.id}/members/{user.id}
Returns the associated RoUser for a server with the following fields.
| Field | Description |
|---|---|
| discord_id | The Discord ID of the user |
| roblox_id | ID of the linked Roblox account for the given guild_id |
| guild_id | The ID of the guild |
Get Discord ID from Roblox ID (Reverse Search)
GET /guilds/{guild.id}/members/roblox/{roblox_id}
Returns an array of discord_id linked to that particular Roblox account for the given guild_id.
NOTE: This endpoint will only return the set of Discord IDs from which Reverse Search consent has given. Reverse Search Consent can be given with /api consent reverse-search.
Get Blacklists
GET /guilds/{guild.id}/blacklists
Returns an array of blacklists for the given guild. Each blacklist has the following fields.
| Field | Description |
|---|---|
| blacklist_id | The internal ID for the blacklist |
| reason | The reason set for the blacklist |
| kind | The type of the blacklist (0 - User, 1 - Group) |
| user_id? | The ID of the Roblox User in the blacklist. Present only when kind = 0 |
| group_id? | The ID of the Roblox Group in the blacklist. Present only when kind = 1 |
*Currently doesn’t return the custom blacklists.
Create Blacklist
POST /guilds/{guild.id}/blacklists
Creates a blacklist for the given guild. The following fields are required.
| Field | Description |
|---|---|
| reason | The reason set for the blacklist |
| kind | The type of the blacklist (0 - User, 1 - Group) |
| user_id? | The ID of the Roblox User in the blacklist. Must be present only when kind = 0 |
| group_id? | The ID of the Roblox Group in the blacklist. Must be present only when kind = 1 |
Delete Blacklist
DELETE /guilds/{guild.id}/blacklists
Deletes blacklists from the given guild. It requires an array of blacklist_id in the body (blacklist_id can be obtained from the Get Blacklists endpoint).
Add/Remove XP
PATCH /guilds/{guild.id}/tower/xp/users/{roblox_id}
Adds/Removes XP to the given Roblox user. It will also promote or demote the user depending on the XP binds. The following fields are required.
| Field | Description |
|---|---|
| xp | The amount of XP to add or remove |
Set XP
POST /guilds/{guild.id}/tower/xp/users/{roblox_id}
Sets XP of the given Roblox user. This will override the previous XP and will also promote or demote the user without taking the current rank into consideration. The following fields are required.
| Field | Description |
|---|---|
| xp | The amount of XP to set |
Set Rank
POST /guilds/{guild.id}/setrank
Sets the rank of the given Roblox user in the given Roblox group. This has no effect on the XP.
| Field | Description |
|---|---|
| user_id | The ID of the Roblox User |
| group_id | The ID of the Roblox Group |
| rank_id | The ID of the rank in the Roblox Group (1-255) |