本頁內容
請協助翻譯

這份文件是由社群協作翻譯的。您可以從Crowdin進行文件翻譯。感謝您的協助🙏

MiAuth方式でのアクセストークン取得方式

アプリケーションを利用するユーザー(以下単に「ユーザー」と呼びます)のアクセストークンを取得するには、以下の手順で発行をリクエストします。

提示

以下に説明する方法は、アプリを作成せずインスタントにアクセストークンを発行する、MiAuthと呼ばれるものです。

Step 1

UUIDを生成する。以後これをセッションIDと呼びます。

警告

このセッションIDは毎回生成し、使いまわさないようにしてください。

Step 2

アプリケーション認証フォームをユーザーのブラウザで表示させる。認証フォームは、以下の形式のURLで開くことができます:

https://misskey.io/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f?name=MyApp&callback=https%3A%2F%2Fmyapp.example.com%2Fcallback&permission=write:notes,write:following,read:drive

ここで、

  • {host}の部分は、ユーザーのサーバーのホストに置き換えます。通常ホストはユーザーが入力します。
  • {session}の部分は、セッションIDに置き換えます。

使用者授予應用程式存取權限後,向下列格式的網址傳送 POST 請求,將傳回一個包含存取權杖的 JSON 作為回應。

名前説明
nameアプリケーション名。
iconアプリケーションのアイコン画像URL。
callback認証が終わった後にリダイレクトするURL。
リダイレクト時には、sessionというクエリパラメータでセッションIDが付きます。
permissionアプリケーションが要求する権限。
要求する権限を,で区切って列挙します。権限の一覧はこちらで確認できます。
https://misskey.io/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f?name=MyApp&callback=https%3A%2F%2Fmyapp.example.com%2Fcallback&permission=write:notes,write:following,read:drive

Step 3

ユーザーがアプリケーションアクセスを許可した後、次の形式のURLにPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。

https://{host}/api/miauth/{session}/check

ここで、

  • 所有 HTTP API 均為 POST,請求和回應均為 JSON 格式(drive/files/create 除外)。
  • 在請求標頭中指定 Content-Type: application/json

レスポンスに含まれるプロパティは以下の通りです:

名前説明
tokenユーザーのアクセストークン。
userユーザーの情報。