メインコンテンツまでスキップ

ShuttlePub API v1 (1.0.0)

Download OpenAPI specification:Download

WIP~

Account

ユーザーアカウント

Signup

新規アカウントを作成します

Request Body schema: application/json
account_name
string
mail
string
password
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "accountId": 6446348271139192,
  • "token": "*************************"
}

Login

アカウントにログインします

Request Body schema: application/json
mail
string
password
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "accountId": 6446348271139192,
  • "token": "*************************"
}

Delete account

アカウントを削除します

path Parameters
target
required
string

The name or id of the user

header Parameters
token
required
string
Example: ******************

User token

Responses

Response samples

Content type
application/json
{
  • "accountId": 6446348271139192,
  • "token": "*************************"
}

Profile

ユーザープロフィール

Get profile

対象のプロフィールを取得します

path Parameters
target
required
string

The name or id of the user

Responses

Response samples

Content type
application/json
{}

Update profile

対象のプロフィールを更新します

path Parameters
target
required
string

The name or id of the user

header Parameters
token
required
string
Example: ******************

User token

Request Body schema: application/json
required
display_name
string
summary
string
icon
string
banner
string
Array of objects (Profile-meta)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}