Inscription et API de grille

Vue d'ensemble

Les API Breakroom nécessitent que des accès spécifiques soient accordés à votre compte. Si vous êtes le propriétaire du monde (World Owner), cet accès devrait être automatiquement activé sur votre compte utilisateur.

Dans cette section de la documentation, les mondes Breakroom sont désignés sous le terme de grilles. Comme Breakroom est basé sur la plateforme de monde virtuel Sinespace, vous pourriez également voir le nom Sinespace utilisé à la place de Breakroom.

info

Vous pouvez envoyer les paramètres soit en tant que données de formulaire POST form_data, soit en tant que paramètres de requête dans l'URL.

info

Toutes les API nécessitent l'envoi de trois paramètres POST supplémentaires :adminname, adminpwd, et gridid. Il s'agit du nom d'utilisateur et du mot de passe d'un compte disposant de droits d'administrateur sur la grille, ainsi que de l'identifiant de la grille avec laquelle vous souhaitez interagir. Nous recommandons de créer un nouvel utilisateur spécifiquement pour ce rôle.

API de gestion des utilisateurs

Inscrire un utilisateur

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

Ce point de terminaison vous permet d'inscrire de nouveaux utilisateurs automatiquement.

Paramètres de requête

Nom	Type	Description
gridid	integer	L'identifiant unique de la grille où l'utilisateur sera inscrit.
password	string	Le mot de passe initial de l'utilisateur.
email	string	L'adresse e-mail de l'utilisateur. Nous n'enverrons aucun message à cette adresse sauf si l'utilisateur le demande (par exemple, réinitialisation du mot de passe).
username	string	Le nom d'utilisateur souhaité. Si un nom d'utilisateur particulier est déjà pris, une itération du nom fourni sera attribuée au compte (par exemple, "NomUtilisateur01").
playeroutfitid	integer	L'"ID de tenue" que l'utilisateur doit porter lors de sa première connexion. Comme cela crée des copies "gratuites" d'articles qui peuvent être listés comme des articles payants dans la boutique Sine Wave Shop, le créateur des articles doit être un administrateur de la grille concernée.

200 Le compte utilisateur a été créé.

<?xml version="1.0" encoding="utf-8"?>
<AddUserResponse><UserID>2099396</UserID></AddUserResponse>

400 Entrée incorrecte ou invalide, ou similaire.

<?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>A user account with that name already exists.</message></Response>

Supprimer un utilisateur

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

Supprime ou désactive un compte utilisateur.

Paramètres de chemin

Nom	Type	Description
userid	integer	L'identifiant utilisateur associé au compte utilisateur.

200

<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>

Mettre à jour un utilisateur

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

Modifie les informations d'un compte utilisateur.

Paramètres de requête

Nom	Type	Description
userid	integer	L'identifiant utilisateur associé au compte utilisateur.
email	string	Mise à jour de l'adresse e-mail de l'utilisateur.
password	string	Mise à jour du mot de passe de l'utilisateur.

200

<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>

Obtenir un utilisateur

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

Retourne une liste groupée d'utilisateurs associés à la grille.

Paramètres de requête

Nom	Type	Description
userids	string	Une liste d'identifiants utilisateurs séparés par des virgules pour lesquels vous souhaitez obtenir des informations.
offset	integer	La requête retournera un maximum de 100 enregistrements. Si plus sont disponibles, utilisez "offset" pour retourner les résultats au-delà de ce point.

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>

Obtenir un utilisateur par e-mail

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

Récupère les informations d'un utilisateur individuel via son adresse e-mail.

Paramètres de requête

Nom	Type	Description
email	string	L'adresse e-mail associée au compte.

200

<?xml version="1.0" encoding="utf-8"?>
<GetUserResponse><UserID>2099560</UserID><UserName>username</UserName><Email>username@test1.com</Email><Gender>M</Gender></GetUserResponse>

Mettre à jour la région de connexion

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

Met à jour l'utilisateur et définit sa scène de connexion sur l'identifiant spécifié.

Paramètres de requête

Nom	Type	Description
userid	integer	L'utilisateur spécifique dont vous souhaitez mettre à jour la scène de connexion.
regionid	integer	La scène que vous souhaitez définir comme scène de connexion de l'utilisateur. Définissez sur zéro pour revenir au défaut de la grille.

200

<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>

API de région

Créer une région

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

Crée une nouvelle région sur la grille.

Paramètres de requête

Nom	Type	Description
owner	integer	L'identifiant utilisateur qui sera marqué comme propriétaire de la région.
templateid	integer	L'identifiant de l'article pour le modèle de région à utiliser.
accesslevel	integer	Soit "0" pour aucun accès, "1" pour accès libre, "2" pour accès amis uniquement, et "3" pour accès approuvé uniquement.
regionname	string	Le nom de la région que vous souhaitez créer.

200 La région a été créée avec succès.

<?xml version="1.0" encoding="utf-8"?>
<CreateRegionResponse><RegionID>152860</RegionID></CreateRegionResponse>

400 Une erreur a été trouvée dans les entrées.

<?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>Room template not available, please try another.</message></Response>

Définir le rôle de région

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

Définit ou modifie le rôle d'un utilisateur au sein d'une région particulière.

Paramètres de requête

Nom	Type	Description
regionid	integer	L'identifiant de la région.
userid	integer	L'identifiant de l'utilisateur concerné.
role	string	Soit "Normal", "Admin" ou "Blocked".

200

<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>

400

<?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>The data provided is incorrect:  role = abc</message></Response>

Obtenir les régions

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

Demande une liste des régions sur la grille.

Paramètres de requête

Nom	Type	Description
offset	integer	Décale les résultats s'il y en a trop pour être retournés en une seule requête.
owner	integer	Retourne les régions appartenant au compte d'un propriétaire particulier.
regionids	string	Une liste CSV d'identifiants de région pour lesquels retourner des informations.

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>

Mettre à jour une région

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

Met à jour les informations concernant une région particulière.

Paramètres de requête

Nom	Type	Description
regionid	integer	L'identifiant de la région pour laquelle mettre à jour les informations.
regionname	string	Si présent, modifie le nom de la région.
templateid	integer	Si présent, modifie le modèle de la région vers l'identifiant de modèle spécifié.
accesslevel	integer	Soit "0" - aucun accès, "1" - accès libre, "2" - accès amis uniquement, et "3" - accès approuvé uniquement.

200

<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>