forked from FoundKeyGang/FoundKey
fix(docs): Update api doc
This commit is contained in:
parent
0c1de7b1b6
commit
b9c5e95b85
1 changed files with 8 additions and 10 deletions
|
@ -8,20 +8,18 @@ APIを使い始めるには、まずアクセストークンを取得する必
|
||||||
|
|
||||||
## アクセストークンの取得
|
## アクセストークンの取得
|
||||||
基本的に、APIはリクエストにはアクセストークンが必要となります。
|
基本的に、APIはリクエストにはアクセストークンが必要となります。
|
||||||
あなたの作ろうとしているアプリケーションが、あなた専用のものなのか、それとも不特定多数の人に使ってもらうものなのかによって、アクセストークンの取得手順は異なります。
|
APIにリクエストするのが自分自身なのか、不特定の利用者に使ってもらうアプリケーションなのかによって取得手順は異なります。
|
||||||
|
|
||||||
* あなた専用の場合: [「自分のアカウントのアクセストークンを取得する」](#自分のアカウントのアクセストークンを取得する)に進む
|
* 前者の場合: [「自分自身のアクセストークンを手動発行する」](#自分自身のアクセストークンを手動発行する)に進む
|
||||||
* 皆に使ってもらう場合: [「アプリケーションとしてアクセストークンを取得する」](#アプリケーションとしてアクセストークンを取得する)に進む
|
* 後者の場合: [「アプリケーション利用者にアクセストークンの発行をリクエストする」](#アプリケーション利用者にアクセストークンの発行をリクエストする)に進む
|
||||||
|
|
||||||
### 自分のアカウントのアクセストークンを取得する
|
### 自分自身のアクセストークンを手動発行する
|
||||||
「設定 > API」で、自分のアクセストークンを取得できます。
|
「設定 > API」で、自分のアクセストークンを発行できます。
|
||||||
|
|
||||||
> この方法で入手したアクセストークンは強力なので、第三者に教えないでください(アプリなどにも入力しないでください)。
|
|
||||||
|
|
||||||
[「APIの使い方」へ進む](#APIの使い方)
|
[「APIの使い方」へ進む](#APIの使い方)
|
||||||
|
|
||||||
### アプリケーションとしてアクセストークンを取得する
|
### アプリケーション利用者にアクセストークンの発行をリクエストする
|
||||||
アプリケーションを使ってもらうには、ユーザーのアクセストークンを以下の手順で取得する必要があります。
|
アプリケーション利用者のアクセストークンを取得するには、以下の手順で発行をリクエストします。
|
||||||
|
|
||||||
#### Step 1
|
#### Step 1
|
||||||
|
|
||||||
|
@ -48,7 +46,7 @@ UUIDを生成する。以後これをセッションIDと呼びます。
|
||||||
* どのような権限があるかは[APIリファレンス](/api-doc)で確認できます
|
* どのような権限があるかは[APIリファレンス](/api-doc)で確認できます
|
||||||
|
|
||||||
#### Step 3
|
#### Step 3
|
||||||
ユーザーが連携を許可した後、`{_URL_}/api/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
|
ユーザーが発行を許可した後、`{_URL_}/api/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
|
||||||
|
|
||||||
レスポンスに含まれるプロパティ:
|
レスポンスに含まれるプロパティ:
|
||||||
* `token` ... ユーザーのアクセストークン
|
* `token` ... ユーザーのアクセストークン
|
||||||
|
|
Loading…
Reference in a new issue