SuperDicq/FoundKey
1
0
Fork 0
forked from FoundKeyGang/FoundKey
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update api.ja.pug

Browse source
This commit is contained in:
syuilo 2017-12-18 00:37:19 +09:00
parent 49fff2137a
commit 71d359bc46
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/web/docs/api.ja.pug
View file

@ -22,7 +22,7 @@ section
section section
h3 1.アプリケーションを登録する h3 1.アプリケーションを登録する
p まず、あなたのWebサービスやアプリケーションをMisskeyに登録します。 p まず、あなたのアプリケーションやWebサービス(以後、あなたのアプリと呼びます)をMisskeyに登録します。
p p
a(href=common.config.dev_url, target="_blank") デベロッパーセンター a(href=common.config.dev_url, target="_blank") デベロッパーセンター
| にアクセスし、「アプリ > アプリ作成」に進みます。 | にアクセスし、「アプリ > アプリ作成」に進みます。
@ -36,23 +36,23 @@ section
tbody tbody
tr tr
td アプリケーション名 td アプリケーション名
td あなたのアプリケーションやWebサービスの名称。 td あなたのアプリの名称。
tr tr
td アプリの概要 td アプリの概要
td あなたのアプリケーションやWebサービスの簡単な説明や紹介。 td あなたのアプリの簡単な説明や紹介。
tr tr
td コールバックURL td コールバックURL
td あなたのアプリケーションがWebサービスである場合、ユーザーが後述する認証フォームで認証を終えた際にリダイレクトするURLを設定できます。 td あなたのアプリがWebサービスである場合、ユーザーが後述する認証フォームで認証を終えた際にリダイレクトするURLを設定できます。
tr tr
td 権限 td 権限
td あなたのアプリケーションやWebサービスが要求する権限。ここで要求した機能だけがAPIからアクセスできます。 td あなたのアプリが要求する権限。ここで要求した機能だけがAPIからアクセスできます。
p 登録が済むとアプリケーションのシークレットキーが入手できます。このシークレットキーは後で使用します。 p 登録が済むとあなたのアプリのシークレットキーが入手できます。このシークレットキーは後で使用します。
div.ui.info.warn: p %fa:exclamation-triangle%アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。 div.ui.info.warn: p %fa:exclamation-triangle%アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。
section section
h3 2.ユーザーに認証させる h3 2.ユーザーに認証させる
p あなたのアプリケーションを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。 p あなたのアプリを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。
p p
| 認証セッションを開始するには、#{common.config.api_url}/auth/session/generate へパラメータに app_secret としてシークレットキーを含めたリクエストを送信します。 | 認証セッションを開始するには、#{common.config.api_url}/auth/session/generate へパラメータに app_secret としてシークレットキーを含めたリクエストを送信します。
| リクエスト形式はJSONで、メソッドはPOSTです。 | リクエスト形式はJSONで、メソッドはPOSTです。
@ -60,10 +60,10 @@ section
p p
| あなたのアプリがコールバックURLを設定している場合、 | あなたのアプリがコールバックURLを設定している場合、
| ユーザーがアプリの連携を許可すると設定しているコールバックURLに token という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。 | ユーザーがあなたのアプリの連携を許可すると設定しているコールバックURLに token という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
p p
| あなたのアプリがコールバックURLを設定していない場合、ユーザーがアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。 | あなたのアプリがコールバックURLを設定していない場合、ユーザーがあなたのアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。
section section
h3 3.ユーザーのアクセストークンを取得する h3 3.ユーザーのアクセストークンを取得する
@ -78,14 +78,14 @@ section
tr tr
td app_secret td app_secret
td string td string
td アプリのシークレットキー td あなたのアプリのシークレットキー
tr tr
td token td token
td string td string
td セッションのトークン td セッションのトークン
p 上手くいけば、認証したユーザーのアクセストークンがレスポンスとして取得できます。おめでとうございます！ p 上手くいけば、認証したユーザーのアクセストークンがレスポンスとして取得できます。おめでとうございます！
p アクセストークンが取得できたら、「ユーザーのアクセストークン+アプリのシークレットキーをsha256したもの」を「i」というパラメータでリクエストに含めると、APIにアクセスすることができます。 p アクセストークンが取得できたら、「ユーザーのアクセストークン+あなたのアプリのシークレットキーをsha256したもの」を「i」というパラメータでリクエストに含めると、APIにアクセスすることができます。
p APIの詳しい使用法は「Misskey APIの利用」セクションをご覧ください。 p APIの詳しい使用法は「Misskey APIの利用」セクションをご覧ください。