API

We will not provide support for API usage.

Using the API

You call easyRanking through the easyRanking bindable in ServerStorage.

local API = game:GetService("ServerStorage"):WaitForChild("easyRanking")

Use API:Invoke(Action, Payload) to make requests.

Wrap calls in pcall if you want error safety.

Examples

Promote

ScaleCode is optional.

It is required for new scales, or promoting to the top of a scale.

API:Invoke("Promote", {
	UserId = 1234567890, -- Target user id
	ModId = 1234567890, -- Moderator user id
	ScaleCode = "SC", -- Optional
})

Demote

API:Invoke("Demote", {
	UserId = 1234567890, -- Target user id
	ModId = 1234567890, -- Moderator user id
})

Return format

Both Promote and Demote return a table.

Successful

{
	success = true,
	rank = "Junior Store Colleague",
}

Failed

{
	success = false,
	error = "Not in scale",
}