まず初めに

備考

APIよりもユーザーとアプリケーションユーザーの差についてもうちょっと知りたい！

ってひとは ここみてね

基本

基本APIリクエストPathは以下の通りです。

https://hss-b-ds.akikaki.net/

警告

これはベータ段階でのURLです。リリース時には現在のURLであるhttps://hss-ds.akikaki.netに変更されます。

また、各Pathはすべて認証を必要とします。

HTTP Headerに Authorization : Bearer <userToken> という方式で指定してください。

基本的なレスポンス形式（成功）

基本的なレスポンス形式は以下の通りです。

• 例：

{
    status : "success"
    data : {
        "hid": "6392036859974772004",
        "username": "yay",
        "developer": true,
        "discordAccount": true,
        "googleAccount": true
    }
}

これはすべてのリクエストに共通して付与されるヘッダ情報です。

基本的なレスポンス形式（失敗）

statusがerrorである場合、必ずmessageフィールドが出現し、dataフィールドは出現しません。

• 例：

{
    "status": "error",
    "message": "Internal Server Error"
}

フィールドの説明

dataフィールド

dataフィールドはstatusがsuccessだった場合にのみ出現するフィールドです。

dataフィールドはそのエンドポイント固有の型を含みます。

messageフィールド

messageフィールドはstatusがerrorだった場合にのみ出現するフィールドです。

messageフィールドは必ずstringを返します。

statusフィールド

statusはレスポンスが成功したか・失敗したかをHTTP StatusCodeとは別に判別します。

必ず下のLiteral（string値）のみを含みます。それ以外は認められません。

コード	成功したか
success	true
error	false

早速始めましょう！

早速やってみましょうね！