All pages
Powered by GitBook
1 of 1

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.

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 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

Delete User

POST https://sine.space/worldapi/externalapi/delete_user

Deletes or disables a user account

Path Parameters

<?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

Name
Type
Description

userid

integer

The user ID associated with this user.

email

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

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

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

Region APIs

Create Region

POST https://sine.space/worldapi/externalapi/create_region

Creates a new region on the grid

Query Parameters

Set Region Role

POST https://sine.space/worldapi/externalapi/set_region_role

Query Parameters

Get Regions

POST https://sine.space/worldapi/externalapi/get_regions

Requests a list of regions on the Grid

Query Parameters

Update Region

POST https://sine.space/worldapi/externalapi/update_region

Updates information about a particular region

Query Parameters