Overview
The ReAdmin Ranking Module enables you to interact with the ReAdmin Ranking API to manage Roblox group ranks, shout messages, and process join requests efficiently within your game. It simplifies communication with the ReAdmin Ranking API, allowing you to focus on game logic rather than API intricacies.Getting Started
Before getting started, ensure you have a valid ReAdmin Ranking Key from the ReAdmin dashboard. This key is required to authenticate requests. Installation:- Locate the ReAdmin Ranking Module on Roblox: ReAdmin Ranking Module (Asset ID: 104472617301635)
- Insert the module into your game (e.g., into ReplicatedStorage).
- Require the module and initialize it using your ReAdmin Ranking Key.
Note: It is recommended to use the require() call directly on the asset ID. This approach allows you to seamlessly receive updates to the module without manually re-importing it into your project.
Usage and Examples
Once you have initialized the module, you have access to several methods for managing group ranks, join requests, shouts, and more.Retrieve Ranking Key Info
Get details about your ranking key and its configuration:Ranking Users
Ranking Users To rank a user in your group, use the rankUser method. Provide a valid Roblox user ID and a rank ID (1-255). The specified rank ID must be allowed by your ReAdmin Ranking Key configuration.Exile Users
Exiling Users To exile (remove) a user from your group, call the exileUser method:Managing Join Requests
If your ranking key supports join request management, you can fetch pending join requests and accept or decline them.Posting a Shout to the Group Wall
If allowed by your key, you can post a shout message to your Roblox group wall:Common Error Responses
- Unauthorized (401): If the
success
field isfalse
with a reason like “Rank is not allowed”, verify that the rank ID you are attempting to set is permitted by your ranking key’s configuration. - Bad Request (400): Verify that the user exists and that you have the correct user ID.
- Server Error (500): Check that the ReAdmin API is functioning correctly and that your requests are formatted properly.