View on GitHub

api-docs_old

jao Minecraft Server API Documentation

Resources/Club

clubjaoafa 関連 API
/clubjaoafaも参考。

Get User (From UserToken)

ユーザートークンから clubjaoafa アカウント情報を取得する。

Request Parameters

Field Description Example Remarks
usertoken UserToken XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 32 桁、英数字。

Response

基本レスポンスに加え、以下が返却されます。

Field Description Example Remarks
data clubjaoafa アカウントオブジェクト    

Get Token

ユーザーの入力したログイン情報からアカウントの存在確認をし、トークンを返します。

Request Parameters

Field Description Example Remarks
username MinecraftID or MinecraftUUID (with hyphen) X4Z  
password Password xxxxx...  
recaptcha Google reCAPTCHA Token    

Response

基本レスポンスに加え、以下が返却されます。

Field Description Example Remarks
usertoken UserToken XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 32 桁、英数字。

Remarks

Register

ユーザーキーからユーザー情報を取得し clubjaoafa へ新規登録したのち、トークンを返します。

Request Parameters

Field Description Example Remarks
username MinecraftID or MinecraftUUID (with hyphen) X4Z  
password Password xxxxx...  
recaptcha Google reCAPTCHA Token    

Response

基本レスポンスに加え、以下が返却されます。

Field Description Example Remarks
usertoken UserToken XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 32 桁、英数字。

Nickname

ニックネームを設定します。

Request Parameters

Field Description Example Remarks
nickname Nickname Zakuro  
usertoken UserToken XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 32 桁、英数字。
recaptcha Google reCAPTCHA Token    

Response

基本レスポンスに加え、以下が返却されます。

Field Description Example Remarks
nickname Nickname Zakuro 新しいニックネーム。前後空白などが省かれたもの

Logout

ログアウトします。

Request Parameters

Field Description Example Remarks
usertoken UserToken XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 32 桁、英数字。

Response

基本レスポンスが返却されます。