Breakroom
Search…
⌃K
Links

ADVANCED - Registration and grid APIs

Breakroom offers several APIs designed to help you manage users and regions within your world (here referred to as a grid). Learn how to add users, delete users, update regions, and more.
These APIs require specific access to be granted to your account. If you have purchased your own grid, this will be automatically enabled on the primary user account.
You may send parameters as either POST form_data, or as Query parameters on the URL.
All APIs require you send three additional POST parameters:adminname, adminpwd,and gridid.These should be the username and password of an account on the grid with administrator rights, along with the grid with which you intend to interface. We recommend creating a new user for this role specifically.

User Management APIs

post
https://sine.space
/worldapi/externalapi/add_user
Register User
post
https://sine.space
/worldapi/externalapi/delete_user
Delete User
post
https://sine.space
/worldapi/externalapi/update_user
Update User
post
https://sine.space
/worldapi/externalapi/get_users
Get Users
post
https://sine.space
/worldapi/externalapi/get_user_by_email
Get User By Email
post
https://sine.space
/worldapi/externalapi/update_login_region
Update Login Region

Region APIs

post
https://sine.space
/worldapi/externalapi/create_region
Create Region
post
https://sine.space
/worldapi/externalapi/set_region_role
Set Region Role
post
https://sine.space
/worldapi/externalapi/get_regions
Get Regions
post
https://sine.space
/worldapi/externalapi/update_region
Update Region