Registration & Grid API
This API requires 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.
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 you wish to interface with. We recommend creating a new user for this role specifically.
User Management APIs
Register User
POST https://sine.space/worldapi/externalapi/add_user
This endpoint allows you to register new users automatically.
Query Parameters
gridid
integer
The unique grid ID to register the user on.
password
string
The users initial password
string
The users email address. We will not send any messages to this address unless requested by the user (e.g. password reset)
username
string
The desired username for the user
playeroutfitid
integer
The "Outfit ID" the user should be wearing when they first log in. As this creates 'free' copies of items that may be paid items in our marketplace, the creator of the items must be an administrator of the grid in question.
<?xml version="1.0" encoding="utf-8"?>
<AddUserResponse><UserID>2099396</UserID></AddUserResponse><?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>A user account with that name already exists.</message></Response>Delete User
POST https://sine.space/worldapi/externalapi/delete_user
Deletes or disables a user account
Path Parameters
userid
integer
The user ID associated with this user.
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>Update User
POST https://sine.space/worldapi/externalapi/update_user
Changes information about a user account
Query Parameters
userid
integer
The user ID associated with this user.
string
Updates the users email address
password
string
Updates the users password
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>Get Users
POST https://sine.space/worldapi/externalapi/get_users
Returns a bulk list of users associated with the Grid
Query Parameters
userids
string
A comma separated list of user IDs you are interested in information about.
offset
integer
The query will return a maximum of 100 records, if more are available, use 'offset' to return past this point.
<?xml version="1.0" encoding="utf-8"?>
<GetUsersResponse><Users><UserID>2099560</UserID><UserName>username</UserName><Email>[email protected]</Email><Gender>M</Gender></Users><Users><UserID>2099559</UserID><UserName>username2</UserName><Email>[email protected]</Email><Gender>F</Gender></Users></GetUsersResponse>Get User By Email
POST https://sine.space/worldapi/externalapi/get_user_by_email
Retrieves information about an individual user via their email address
Query Parameters
string
The email address associated with the account
<?xml version="1.0" encoding="utf-8"?>
<GetUserResponse><UserID>2099560</UserID><UserName>username</UserName><Email>[email protected]</Email><Gender>M</Gender></GetUserResponse>Update Login Region
POST https://sine.space/worldapi/externalapi/update_login_region
Updates the user, sets their login scene to the specified ID.
Query Parameters
userid
integer
The user to updates user ID
regionid
integer
The scene to make as their login scene. Set to zero to return to grid default.
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>Region APIs
Create Region
POST https://sine.space/worldapi/externalapi/create_region
Creates a new region on the grid
Query Parameters
owner
integer
The user ID to be marked as owner of the region
templateid
integer
The item ID for the region template to use
accesslevel
integer
Either "0" for no access, "1" for free-for-all access, "2" for friends-only access, and "3" for approved only access.
regionname
string
The name of the region you wish to create
<?xml version="1.0" encoding="utf-8"?>
<CreateRegionResponse><RegionID>152860</RegionID></CreateRegionResponse><?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>Room template not available, please try another.</message></Response>Set Region Role
POST https://sine.space/worldapi/externalapi/set_region_role
Query Parameters
regionid
integer
The ID of the region
userid
integer
The ID of the user in question
role
string
Either "Normal", "Admin", or "Blocked".
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response><?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>The data provided is incorrect: role = abc</message></Response>Get Regions
POST https://sine.space/worldapi/externalapi/get_regions
Requests a list of regions on the Grid
Query Parameters
offset
integer
Offsets the results if there is too many to return in a single query.
owner
integer
Return regions owned by this account
regionids
string
A CSV separated list of region IDs to return information about.
<?xml version="1.0" encoding="utf-8"?>
<GetRegionsResponse><Regions><RegionID>50000040</RegionID><RegionName>regionname</RegionName><Owner>2099564</Owner><TemplateID>11</TemplateID><AccessLevel>3</AccessLevel></Regions><Regions><RegionID>50000039</RegionID><RegionName>regionname2</RegionName><Owner>2099563</Owner><TemplateID>11</TemplateID><AccessLevel>1</AccessLevel></Regions><GetRegionsResponse>Update Region
POST https://sine.space/worldapi/externalapi/update_region
Updates information about a particular region
Query Parameters
regionid
integer
The region ID to update information about
regionname
string
If present, changes the name of the region
templateid
integer
If present, changes the template of the region to the specified template ID
accesslevel
integer
Either "0" - no access, "1" - free access, "2" friends-only access, and "3" approved only access.
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>Last updated
Was this helpful?