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

APIドキュメント

作成 : だいちまる

このページをみてくださりありがとうございます！
APIドキュメントです！
まだ実装されていないAPIも今後は追加予定です。
v1.3.4からの仕様変更されたAPIも引き続きご利用いただけます。

警告

uwuzu v1.3.6以降のuwuzuが対象です！

serverinfo-api​

GET
POST

このAPIは以下のリンクより使用が可能です。
サーバー情報を取得できます。

https://{domain}/api/serverinfo-api

必須パラメータ

none

サンプル

{
  "server_info": {
    "server_name": "新規さば",
    "server_icon": "https://uwuzu.example.com/img/uwuzu_icon.png",
    "server_description": "ようこそ新規さばへ！etc...",
    "adminstor": {
      "name": "あどみん",
      "email": "[email protected]"
    },
    "terms_url": "https://uwuzu.example.com/rule/terms",
    "privacy_policy_url": "https://uwuzu.example.com/rule/privacypolicy",
    "max_ueuse_length": 1024,
    "invitation_code": false,
    "account_migration": true,
    "usage": {
      "users": 120,
      "ueuse": 5000
    }
  },
  "software": {
    "name": "uwuzu",
    "version": "1.3.6",
    "repository": "https://github.com/Daichimarukana/uwuzu"
  },
  "server_notice": [
    {
      "title": "お知らせ！",
      "note": "サービスを開始しました！",
      "editor": "admin",
      "datetime": "2024-03-29 14:35:06"
    }
  ]
}

me​

GET
POST

このAPIは以下のリンクより使用が可能です。
自分のユーザー情報を取得できます。
メールアドレスなど一部の情報は取得できません。

https://{domain}/api/me/

必須パラメータ

?token={token}
or
{
  "token":{token}
}

サンプル

{
  "username": "あどみん",
  "userid": "admin",
  "profile": "あどみんです！",
  "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "user_header": https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "registered_date": "2024-03-09 02:19:04",
  "followee": [
    "test1",
    "tester"
  ],
  "followee_cnt": 2,
  "follower": [],
  "follower_cnt": 0,
  "ueuse_cnt": 38,
  "isBot": false,
  "isAdmin": true,
  "role": [
    {
      "name": "ゆーざー",
      "color": "CCCCCC",
      "effect": "none",
      "id": "user"
    }
  ],
  "language": "ja-JP"
}

users​

GET
POST

このAPIは以下のリンクより使用が可能です。
自分以外のユーザー情報を取得できます。

https://{domain}/api/users/

必須パラメータ

?token={token}&userid={userid}
or
{
  "token":{token},
  "userid":{userid}
}

サンプル

{
  "username": "あどみん",
  "userid": "admin",
  "profile": "あどみんです！",
  "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "user_header": https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "registered_date": "2024-03-09 02:19:04",
  "followee": [
    "test1",
    "tester"
  ],
  "followee_cnt": 2,
  "follower": [
    "test1",
  ],
  "follower_cnt": 1,
  "ueuse_cnt": 38,
  "isBot": false,
  "isAdmin": true,
  "role": [
    {
      "name": "ゆーざー",
      "color": "CCCCCC",
      "effect": "none",
      "id": "user"
    }
  ],
  "language": "ja-JP"
}

users/follow​

GET
POST

このAPIは以下のリンクより使用が可能です。
自分以外のユーザーをフォローできます。

https://{domain}/api/users/follow

必須パラメータ

?token={token}&userid={userid}
or
{
  "token":{token},
  "userid":{userid}
}

サンプル

{
  "userid":"admin"
}

users/unfollow​

GET
POST

このAPIは以下のリンクより使用が可能です。
自分以外のユーザーのフォローを解除できます。

https://{domain}/api/users/unfollow

必須パラメータ

?token={token}&userid={userid}
or
{
  "token":{token},
  "userid":{userid}
}

サンプル

{
  "userid":"admin",
  "success":true
}

ueuse​

GET
POST

このAPIは以下のリンクより使用が可能です。
必須パラメータのみ指定の場合直近25件のユーズを取得します。
limitを100件以上にすることはできません。 pageは次のX件を取得します。

https://{domain}/api/ueuse/

必須パラメータ

?token={token}
or
{
  "token":{token}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tzv",
    "text": "Test\nTest",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin",
      "test1"
    ],
    "favorite_cnt": "2",
    "datetime": "2024-04-19 20:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/get​

GET
POST

このAPIは以下のリンクより使用が可能です。
特定の投稿を一つだけ取得します。(単一の投稿を取得します。)

https://{domain}/api/ueuse/get

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "uniqid":{uniqid}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tzv",
    "text": "Test\nTest",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin",
      "test1"
    ],
    "favorite_cnt": "2",
    "datetime": "2024-04-19 20:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/replies​

GET
POST

このAPIは以下のリンクより使用が可能です。
特定の投稿とそれにされた返信を取得します。 帰ってきたjsonの一番上の投稿がuniqidにて指定したものになります。 オプションパラメータで取得する数とページを指定できます。 一度に取得できる最大数は100件です。

https://{domain}/api/ueuse/replies

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "uniqid":{uniqid}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tzv",
    "text": "Test\nTest",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin",
      "test1"
    ],
    "favorite_cnt": "2",
    "datetime": "2024-04-19 20:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  },
  {
    "uniqid": "1vgsg0v3tzb",
    "text": "***Nice***",
    "account": {
      "username": "あどみん2",
      "userid": "admin2",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin"
    ],
    "favorite_cnt": "1",
    "datetime": "2024-04-19 20:33:14",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/mentions​

GET
POST
注意

このAPIの中身は検索APIとほぼ同じものであり、正常にメンションしてきた投稿を取得できない可能性があります。
使用する際は自己責任でお願いします。

このAPIは以下のリンクより使用が可能です。
自分のメンションされた投稿を取得します。

https://{domain}/api/ueuse/mentions

必須パラメータ

?token={token}
or
{
  "token":{token}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tfv",
    "text": "@admin",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "test1"
    ],
    "favorite_cnt": "1",
    "datetime": "2024-04-19 10:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/search​

GET
POST

このAPIは以下のリンクより使用が可能です。
keywordに入れた言葉をすべての投稿の中から検索してマッチしたものを返します。

https://{domain}/api/ueuse/search

必須パラメータ

?token={token}&keyword={keyword}
or
{
  "token":{token},
  "keyword":{keyword}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgs00v3tfv",
    "text": "検索",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "test1"
    ],
    "favorite_cnt": "1",
    "datetime": "2024-04-19 10:34:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/create​

GET
POST

このAPIは以下のリンクより使用が可能です。
このAPIを使用すると新たに投稿をすることができます。

https://{domain}/api/ueuse/create

必須パラメータ

?token={token}&text={text}
or
{
  "token":{token},
  "text":{text}
}

オプションパラメータ
画像の投稿はJSONでPOSTリクエストした際のみ利用できます。
画像はBase64にエンコードして送信する必要があります。
replyidにリプライ先IDを入れることで返信を送信できます。

&nsfw={true/false}&replyid={返信先id}
or
{
  "nsfw":{true/false},
  "Image1":{Base64_Encode_Image},
  "Image2":{Base64_Encode_Image},
  "Image3":{Base64_Encode_Image},
  "Image4":{Base64_Encode_Image},
  "replyid":{Uniqid}
}

サンプル

{
  "uniqid": "qy0lwn9orf",
  "userid": "admin"
}

ueuse/delete​

GET
POST

このAPIは以下のリンクより使用が可能です。
投稿の削除が可能です。

https://{domain}/api/ueuse/delete

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "text":{uniqid}
}

サンプル
エラーが発生した場合にsuccessがfalseになる場合があります。

{
  "uniqid": "qy0lwn9orf",
  "userid": "admin",
  "success":true
}

2024/04/09(最終更新)