The options of integrating a RSPS list into a RuneScape private server is usually limited to placing a voting button on a website, or setting up incentive voting through the callback system. At RuneLocus, we’re providing an API. The RuneLocus API gives servers the option to create custom integrations with RuneLocus.
Finding a vote
Even though the callback system for incentive voting should be enough, there might be a situation in which you’d want to double check whether your player has actually made a vote. Using this API endpoint, you can search within the votes your server has received.
URL
Method
GET
URL Params
Name
callback
server_id
key
Value
int
string
string
Description
The ID of the server that you’re trying to find vote records for.
The API key of the server. This is set in the server’s settings.
The contents of the callback parameter that your player used to vote with (depending on your server’s callback system, this can be a session id, username, IP address, etc.).
Additional
Required
Required
Required
Success Response
Code
200
Body
Error Response
Code
400
Body
This error occurs when the API Key parameter is missing in the URL.
This error occurs when the server ID parameter is missing in the URL.
This error occurs when no action was configured. To search for a vote, make sure to use the correct URL format (shown on top of this documentation).
401
This error occurs when an incorrect API key was provided. Make sure to use the same API key that you configured in your server’s settings.
404
This error occurs when an incorrect server ID was provided. You can find the correct server ID in your server overview in MyLocus.
This error occurs when the provided callback parameter does not exist in our records.
