Versions Roadmap - GiamPy5/WHITELIST_SAMP GitHub Wiki

1.0.0 Stable

---

API Development

GET /api/users/whitelist/{username}?api_key={key}

Check if 'username' is locally in their server or globally banned in the whitelist.

• Controller: ApiKeysController
• Action: users_check_whitelist
• Params: username
• Status: Completed

POST /api/users/whitelist/{username}?api_key={key}

Bans a user (locally from their server or globally in the whitelist if API key is allowed).

• Controller: ApiKeysController
• Action: users_ban_whitelist
• Passed Params: username
• POST Params: type
• Status: Uncompleted

DELETE /api/users/whitelist/{username}?api_key={key}

Unbans a user (only local bans, global bans must be removed from the website).

• Controller: ApiKeysController
• Action: users_unban_whitelist
• Params: username
• Status: Uncompleted

GET /api/users/view/{username}?api_key={key}

Takes the available information of 'username' from the database.

• Controller: ApiKeysController
• Action: users_view
• Params: username
• Status: Completed

GET /api/users/verify/{username}/email/{token}?api_key={key}

Checks if the email token of 'username' is valid.

• Controller: ApiKeysController
• Action: users_verify_email
• Params: username, token
• Status: Uncompleted

POST /api/users/request/{username}/email?api_key={key}

Requests an email token of 'username' to verify the connection.

• Controller: ApiKeysController
• Action: users_request_email
• Params: username
• Status: Uncompleted