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

ユーザー認可によるAPIアクセストークンの取得方法

作成 : だいちまる

このページをみてくださりありがとうございます！
v1.6.0以降で使用できるようになったユーザー認可式のアクセストークンの取得方法を解説するページです！

警告

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

1. 一意のセッションIDを作成する​

UUIDなど、一意さの担保される方法でセッションIDを発行してください！(最大512文字)

そこのお前！！！よく読め！！！！

発行したセッションIDは絶対に使い回さないでください！
また、絶対に第三者に公開しないでください！

2. 認可用ページのURLの作成​

以下のURLをベースに、ユーザーによる認可ページを表示できるリンクを作成します！

https://[ドメイン]/api/auth?session=[セッションID]&client=[サービス・クライアント名]&scope=[要求する権限]

[ドメイン]は、uwuzuサーバーのドメイン名、[セッションID]には先程作成したセッションIDを、[サービス・クライアント名]には作成しているBotやクライアント、アプリの名前を、[要求する権限]には以下で解説する権限を設定してください！

権限は、以下の表の中から選び、必要なもので構成します。
要求する権限を設定しないと、APIは使用できません。

scope権限の内容
read:me重要な情報以外の自分のアカウントの情報を見る
write:me重要な情報以外の自分のアカウントの情報を変更する
read:ueuseユーズを見る
read:users自分以外のユーザーをも見る
write:ueuseユーズの作成・削除をする
write:followフォロー・フォロー解除をする
write:favoriteいいねをする・解除をする
read:notifications通知を見る
write:notifications通知を既読にする
write:bookmarkブックマークにユーズを追加・削除する
read:bookmarkブックマークを見る

また、ここまでの設定ができていてば、拡張として以下の要素を認可ページに追加可能です。

&icon=[サービス・クライアントのロゴやアイコンのURL]&about=[サービス・クライアントの説明]&callback=[コールバック先のURL]

なお、この拡張要素は任意なので追加しなくても大丈夫です！

見ろ！！！！！！！！！！！

URLの作成で、それぞれのクエリにいれる値は必ずURLエンコードして入れてください！

完成したURLの例
https:///localhost/api/auth?session=3d3f8c73-499b-4f0e-9dfa-816b229034da&client=TestApp&scope=read:account,read:ueuse&icon=https%3A%2F%2Fhttp.cat%2F102&about=%E3%81%93%E3%82%8C%E3%81%AF%E3%83%86%E3%82%B9%E3%83%88%E3%82%A2%E3%83%97%E3%83%AA%E3%81%A7%E3%81%99%EF%BC%81&callback=https%3A%2F%2Fexample.com

3. アクセストークンの取得​

先程作成したURLをアクセストークンを取得したいユーザーアカウントでログインした状態で開くと、認可画面に移ります。
そこで"許可"ボタンを押すことでアクセストークンが発行されます。

発行されたら、以下のURLに以下の内容でGET・POSTすることでアクセストークンと認証したユーザーのユーザー名・ユーザーIDの取得が可能です！

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

必須パラメータ

?session={セッションID}
or
{
  "session":{セッションID}
}

サンプル

{
  "username": "あどみん",
  "userid": "admin",
  "token": "LLOC4YratgfiMPmLBLuL2Gb942xf2XbOZB7cQMKyOtwOweIhWNsorSe08EeYbhlV"
}
見ろ！！！！！！！！！！！

アクセストークンの取得は1回までです！
一度取得すると同じトークンの再取得はできません！！！！！！

ここで取得したアクセストークンを使用して、従来と同じようにAPIを使用可能になります。

2025/07/31(最終更新)