Skip to content
This repository has been archived by the owner on Jun 21, 2022. It is now read-only.

APIの機能一覧

YiB-PC edited this page Oct 10, 2021 · 2 revisions

📝 N O T E

このページは BEditor/api/webapi.md の内容にいくつかの変更を加えたものです
チェックボックスは実装済みか否かを表すものです。


😃 通常ユーザ向け

認証

RefreshAuth

  • OK
POST /api/refreshauth
Authorization: Token リフレッシュトークン

トークンを更新します。

Response body

{
    "access_token": "アクセストークン",
    "expires_in": "このアクセストークンの有効期限 (秒数)",
    "refresh_token": "リフレッシュトークン",
}

SignIn

  • OK
POST /api/signin

サインインします。

Request body

{
    "email": "メールアドレス",
    "password": "パスワード"
}

Response body

{
    "access_token": "アクセストークン",
    "expires_in": "このアクセストークンの有効期限 (秒数)",
    "refresh_token": "リフレッシュトークン",
}

SignUp

  • OK
POST /api/signup

サインアップします。

Request body

{
    "email": "メールアドレス",
    "password": "パスワード",
    "name": "表示名",
    "developer": "アカウントの権限(2:通常ユーザ,3:デベロッパ)"
}

Response body

{
    "access_token": "アクセストークン",
    "expires_in": "このアクセストークンの有効期限 (秒数)",
    "refresh_token": "リフレッシュトークン",
}

GetAccountInfo

  • OK
GET /api/getAccountInfo
Authorization: Token アクセストークン

アカウント情報を取得します。

Response body

{
    "email": "メールアドレス",
    "displayname": "表示名"
}

Update

  • OK
POST /api/update
Authorization: Token アクセストークン

アカウント情報を更新します。

Request body

{
    "email": "メールアドレス",
    "password": "パスワード",
    "name": "表示名"
}

Response body

{
    "access_token": "アクセストークン",
    "expires_in": "このアクセストークンの有効期限 (秒数)",
    "refresh_token": "リフレッシュトークン",
}

DeleteAccount

  • OK
POST /api/deleteAccount
Authorization: Token アクセストークン

アカウントを削除します。

SendPasswordResetEmail

POST /api/sendPasswordResetEmail

パスワードをリセットするメールを送信します。

Request body

{
    "email": "メールアドレス",
}

パッケージ

Upload

  • OK
POST /api/upload
Authorization: Token アクセストークン

パッケージをアップロードします。

Request body

  • パッケージファイル

Response body

{
    "version": "パッケージのバージョン (メジャー.マイナー.ビルド)",
    "download_url": "",
    "update_note": "更新ノート",
    "update_note_short": "短い更新ノート",
    "release_datetime": "公開した日時 (例[2021-05-30T00:00:00.0000000])"
}

GetPackages

  • OK
POST /api/getPackages
Authorization: Token アクセストークン

アップロードしたパッケージを取得します。

Response body

[
    {
        "main_assembly": "",
        "name": "",
        "author": "",
        "homepage": "",
        "description_short": "",
        "description": "",
        "tag": "",
        "id": "",
        "license": "",
        "versions": [
            {
            "version": "",
            "download_url": "",
            "update_note": "",
            "update_note_short": "",
            "release_datetime": ""
            }
        ]
    }
]

😟 管理者向け