这页的内容
请协助我们进行翻译

本文档为社区翻译,您可以通过 Crowdin 翻译该文档。我们需要您的帮助🙏

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

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

提示

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

Step 1

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

警告

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

Step 2

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

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

ここで、

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

また、URLにクエリパラメータとしていくつかのオプションを設定できます:

名前説明
nameアプリケーション名。
iconアプリケーションのアイコン画像URL。
callback認証が終わった後にリダイレクトするURL。
リダイレクト時には、sessionというクエリパラメータでセッションIDが付きます。
permissionアプリケーションが要求する権限。
要求する権限を,で区切って列挙します。権限の一覧はこちらで確認できます。
https://www.yunshi-life.com/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

ここで、

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

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

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