summaryrefslogtreecommitdiff
path: root/src/docs/api.ja-JP.md
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2020-07-18 12:23:57 +0900
committersyuilo <syuilotan@yahoo.co.jp>2020-07-18 12:23:57 +0900
commitb9c5e95b855fcf599b339037d4753252a1f786d4 (patch)
tree3f3232b39b0161ac3e4696c9bf5344bfe629c7ed /src/docs/api.ja-JP.md
parentfeat: トークン手動発行機能 (diff)
downloadsharkey-b9c5e95b855fcf599b339037d4753252a1f786d4.tar.gz
sharkey-b9c5e95b855fcf599b339037d4753252a1f786d4.tar.bz2
sharkey-b9c5e95b855fcf599b339037d4753252a1f786d4.zip
fix(docs): Update api doc
Diffstat (limited to 'src/docs/api.ja-JP.md')
-rw-r--r--src/docs/api.ja-JP.md18
1 files changed, 8 insertions, 10 deletions
diff --git a/src/docs/api.ja-JP.md b/src/docs/api.ja-JP.md
index 7171664f1b..7422307166 100644
--- a/src/docs/api.ja-JP.md
+++ b/src/docs/api.ja-JP.md
@@ -8,20 +8,18 @@ APIを使い始めるには、まずアクセストークンを取得する必
## アクセストークンの取得
基本的に、APIはリクエストにはアクセストークンが必要となります。
-あなたの作ろうとしているアプリケーションが、あなた専用のものなのか、それとも不特定多数の人に使ってもらうものなのかによって、アクセストークンの取得手順は異なります。
+APIにリクエストするのが自分自身なのか、不特定の利用者に使ってもらうアプリケーションなのかによって取得手順は異なります。
-* あなた専用の場合: [「自分のアカウントのアクセストークンを取得する」](#自分のアカウントのアクセストークンを取得する)に進む
-* 皆に使ってもらう場合: [「アプリケーションとしてアクセストークンを取得する」](#アプリケーションとしてアクセストークンを取得する)に進む
+* 前者の場合: [「自分自身のアクセストークンを手動発行する」](#自分自身のアクセストークンを手動発行する)に進む
+* 後者の場合: [「アプリケーション利用者にアクセストークンの発行をリクエストする」](#アプリケーション利用者にアクセストークンの発行をリクエストする)に進む
-### 自分のアカウントのアクセストークンを取得する
-「設定 > API」で、自分のアクセストークンを取得できます。
-
-> この方法で入手したアクセストークンは強力なので、第三者に教えないでください(アプリなどにも入力しないでください)。
+### 自分自身のアクセストークンを手動発行する
+「設定 > API」で、自分のアクセストークンを発行できます。
[「APIの使い方」へ進む](#APIの使い方)
-### アプリケーションとしてアクセストークンを取得する
-アプリケーションを使ってもらうには、ユーザーのアクセストークンを以下の手順で取得する必要があります。
+### アプリケーション利用者にアクセストークンの発行をリクエストする
+アプリケーション利用者のアクセストークンを取得するには、以下の手順で発行をリクエストします。
#### Step 1
@@ -48,7 +46,7 @@ UUIDを生成する。以後これをセッションIDと呼びます。
* どのような権限があるかは[APIリファレンス](/api-doc)で確認できます
#### Step 3
-ユーザーが連携を許可した後、`{_URL_}/api/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
+ユーザーが発行を許可した後、`{_URL_}/api/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
レスポンスに含まれるプロパティ:
* `token` ... ユーザーのアクセストークン