summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2017-12-18 00:37:19 +0900
committersyuilo <Syuilotan@yahoo.co.jp>2017-12-18 00:37:19 +0900
commit71d359bc46cb806a3bd53f65ecc1e1253839225a (patch)
tree7a5c21ca79110b493895c312d09056ba8a219219 /src
parentレスポンシブに (diff)
downloadsharkey-71d359bc46cb806a3bd53f65ecc1e1253839225a.tar.gz
sharkey-71d359bc46cb806a3bd53f65ecc1e1253839225a.tar.bz2
sharkey-71d359bc46cb806a3bd53f65ecc1e1253839225a.zip
Update api.ja.pug
Diffstat (limited to 'src')
-rw-r--r--src/web/docs/api.ja.pug22
1 files changed, 11 insertions, 11 deletions
diff --git a/src/web/docs/api.ja.pug b/src/web/docs/api.ja.pug
index 2584b08581..78749e83e7 100644
--- a/src/web/docs/api.ja.pug
+++ b/src/web/docs/api.ja.pug
@@ -22,7 +22,7 @@ section
section
h3 1.アプリケーションを登録する
- p まず、あなたのWebサービスやアプリケーションをMisskeyに登録します。
+ p まず、あなたのアプリケーションやWebサービス(以後、あなたのアプリと呼びます)をMisskeyに登録します。
p
a(href=common.config.dev_url, target="_blank") デベロッパーセンター
| にアクセスし、「アプリ > アプリ作成」に進みます。
@@ -36,23 +36,23 @@ section
tbody
tr
td アプリケーション名
- td あなたのアプリケーションやWebサービスの名称。
+ td あなたのアプリの名称。
tr
td アプリの概要
- td あなたのアプリケーションやWebサービスの簡単な説明や紹介。
+ td あなたのアプリの簡単な説明や紹介。
tr
td コールバックURL
- td あなたのアプリケーションがWebサービスである場合、ユーザーが後述する認証フォームで認証を終えた際にリダイレクトするURLを設定できます。
+ td あなたのアプリがWebサービスである場合、ユーザーが後述する認証フォームで認証を終えた際にリダイレクトするURLを設定できます。
tr
td 権限
- td あなたのアプリケーションやWebサービスが要求する権限。ここで要求した機能だけがAPIからアクセスできます。
+ td あなたのアプリが要求する権限。ここで要求した機能だけがAPIからアクセスできます。
- p 登録が済むとアプリケーションのシークレットキーが入手できます。このシークレットキーは後で使用します。
+ p 登録が済むとあなたのアプリのシークレットキーが入手できます。このシークレットキーは後で使用します。
div.ui.info.warn: p %fa:exclamation-triangle%アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。
section
h3 2.ユーザーに認証させる
- p あなたのアプリケーションを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。
+ p あなたのアプリを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。
p
| 認証セッションを開始するには、#{common.config.api_url}/auth/session/generate へパラメータに app_secret としてシークレットキーを含めたリクエストを送信します。
| リクエスト形式はJSONで、メソッドはPOSTです。
@@ -60,10 +60,10 @@ section
p
| あなたのアプリがコールバックURLを設定している場合、
- | ユーザーがアプリの連携を許可すると設定しているコールバックURLに token という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
+ | ユーザーがあなたのアプリの連携を許可すると設定しているコールバックURLに token という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
p
- | あなたのアプリがコールバックURLを設定していない場合、ユーザーがアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。
+ | あなたのアプリがコールバックURLを設定していない場合、ユーザーがあなたのアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。
section
h3 3.ユーザーのアクセストークンを取得する
@@ -78,14 +78,14 @@ section
tr
td app_secret
td string
- td アプリのシークレットキー
+ td あなたのアプリのシークレットキー
tr
td token
td string
td セッションのトークン
p 上手くいけば、認証したユーザーのアクセストークンがレスポンスとして取得できます。おめでとうございます!
- p アクセストークンが取得できたら、「ユーザーのアクセストークン+アプリのシークレットキーをsha256したもの」を「i」というパラメータでリクエストに含めると、APIにアクセスすることができます。
+ p アクセストークンが取得できたら、「ユーザーのアクセストークン+あなたのアプリのシークレットキーをsha256したもの」を「i」というパラメータでリクエストに含めると、APIにアクセスすることができます。
p APIの詳しい使用法は「Misskey APIの利用」セクションをご覧ください。