注册与网格 API
概述
Breakroom API 需要向您的账户授予特定的访问权限。如果您是 World Owner（世界所有者），此访问权限应会自动在您的用户账户上启用。
在本节文档中，Breakroom Worlds 将被称为 grids（网格）。由于 Breakroom 基于 Sinespace 虚拟世界平台，您可能会看到使用 Sinespace 一词来代替 Breakroom。
您可以将参数作为 POST form_data 发送，也可以作为 URL 上的查询参数发送。
所有 API 都要求您发送三个额外的 POST 参数：adminname, adminpwd, 和 gridid.这些应该是具有管理员权限的网格账户的用户名和密码，以及您打算接口的网格。我们建议为此角色专门创建一个新用户。
用户管理 API
注册用户
POST https://sine.space/worldapi/externalapi/add_user
此端点允许您自动注册新用户。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| gridid | integer | 用户将注册的唯一网格 ID。 |
| password | string | 用户的初始密码。 |
| string | 用户的电子邮件地址。除非用户请求（例如重置密码），否则我们不会向此地址发送任何消息。 | |
| username | string | 期望的用户名。如果特定的用户名已被占用，将向该账户分配所提供名称的迭代版本（例如 "User Name01"）。 |
| playeroutfitid | integer | 用户首次登录时应穿着的“服装 ID”。由于这会创建可能在 Sine Wave Shop 上列为付费项目的物品的“免费”副本，因此该物品的创建者必须是相关网格的管理员。 |
- 200 用户账户已创建。
- 400 输入错误或无效，或类似情况。
<?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>
删除用户
POST https://sine.space/worldapi/externalapi/delete_user
删除或禁用用户账户。
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userid | integer | 与用户账户关联的用户 ID。 |
- 200
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>
更新用户
POST https://sine.space/worldapi/externalapi/update_user
更改有关用户账户的信息。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userid | integer | 与用户账户关联的用户 ID。 |
| string | 更新用户的电子邮件地址。 | |
| password | string | 更新用户的密码。 |
- 200
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>
获取用户
POST https://sine.space/worldapi/externalapi/get_users
返回与网格关联的用户批量列表。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userids | string | 您希望返回其信息的用户 ID 的逗号分隔列表。 |
| offset | integer | 查询将返回最多 100 条记录。如果还有更多记录，请使用“offset”返回此点之后的记录。 |
- 200
<?xml version="1.0" encoding="utf-8"?>
<GetUsersResponse><Users><UserID>2099560</UserID><UserName>username</UserName><Email>username@test1.com</Email><Gender>M</Gender></Users><Users><UserID>2099559</UserID><UserName>username2</UserName><Email>username2@test1.com</Email><Gender>F</Gender></Users></GetUsersResponse>
通过电子邮件获取用户
POST https://sine.space/worldapi/externalapi/get_user_by_email
通过电子邮件地址检索有关单个用户的信息。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| string | 与账户关联的电子邮件地址。 |
- 200
<?xml version="1.0" encoding="utf-8"?>
<GetUserResponse><UserID>2099560</UserID><UserName>username</UserName><Email>username@test1.com</Email><Gender>M</Gender></GetUserResponse>
更新登录区域
POST https://sine.space/worldapi/externalapi/update_login_region
更新用户，并将其登录场景设置为指定的 ID。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| userid | integer | 您希望更新其登录场景的特定用户。 |
| regionid | integer | 您希望设置为用户登录场景的场景。设置为零以返回网格默认值。 |
- 200
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>
区域 API
创建区域
POST https://sine.space/worldapi/externalapi/create_region
在网格上创建一个新区域。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| owner | integer | 将被标记为区域所有者的用户 ID。 |
| templateid | integer | 要使用的区域模板的项目 ID。 |
| accesslevel | integer | “0”表示无访问权限，“1”表示自由访问，“2”表示仅限好友访问，“3”表示仅限批准访问。 |
| regionname | string | 您希望创建的区域的名称。 |
- 200 区域创建成功。
- 400 输入中发现错误。
<?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>
设置区域角色
POST https://sine.space/worldapi/externalapi/set_region_role
设置或更改用户在特定区域内的角色。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| regionid | integer | 区域的 ID。 |
| userid | integer | 相关用户的 ID。 |
| role | string | “Normal”（普通）、“Admin”（管理员）或“Blocked”（已阻止）。 |
- 200
- 400
<?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>
获取区域
POST https://sine.space/worldapi/externalapi/get_regions
请求网格上的区域列表。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| offset | integer | 如果结果太多无法在单个查询中返回，则偏移结果。 |
| owner | integer | 返回由特定所有者账户拥有的区域。 |
| regionids | string | 要返回其信息的区域 ID 的 CSV 列表。 |
- 200
<?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>
更新区域
POST https://sine.space/worldapi/externalapi/update_region
更新有关特定区域的信息。
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
| regionid | integer | 要更新其信息的区域 ID。 |
| regionname | string | 如果存在，则更改区域的名称。 |
| templateid | integer | 如果存在，则将区域的模板更改为指定的模板 ID。 |
| accesslevel | integer | “0” - 无访问权限，“1” - 自由访问，“2” - 仅限好友访问，“3” - 仅限批准访问。 |
- 200
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>