From 6be127e18bdbea6031698baeb8632f917a8346eb Mon Sep 17 00:00:00 2001 From: syuilo Date: Sat, 28 Mar 2020 11:24:37 +0900 Subject: Implement MiAuth --- src/docs/api.ja-JP.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'src/docs') diff --git a/src/docs/api.ja-JP.md b/src/docs/api.ja-JP.md index 5d370a29cd..f47aeb81cf 100644 --- a/src/docs/api.ja-JP.md +++ b/src/docs/api.ja-JP.md @@ -3,25 +3,25 @@ MisskeyAPIを使ってMisskeyクライアント、Misskey連携Webサービス、Bot等(以下「アプリケーション」と呼びます)を開発できます。 ストリーミングAPIもあるので、リアルタイム性のあるアプリケーションを作ることも可能です。 -APIを使い始めるには、まずAPIキーを取得する必要があります。 -このドキュメントでは、APIキーを取得する手順を説明した後、基本的なAPIの使い方を説明します。 +APIを使い始めるには、まずアクセストークンを取得する必要があります。 +このドキュメントでは、アクセストークンを取得する手順を説明した後、基本的なAPIの使い方を説明します。 -## APIキーの取得 -基本的に、APIはリクエストにはAPIキーが必要となります。 -あなたの作ろうとしているアプリケーションが、あなた専用のものなのか、それとも不特定多数の人に使ってもらうものなのかによって、APIキーの取得手順は異なります。 +## アクセストークンの取得 +基本的に、APIはリクエストにはアクセストークンが必要となります。 +あなたの作ろうとしているアプリケーションが、あなた専用のものなのか、それとも不特定多数の人に使ってもらうものなのかによって、アクセストークンの取得手順は異なります。 -* あなた専用の場合: [「自分のアカウントのAPIキーを取得する」](#自分のアカウントのAPIキーを取得する)に進む -* 皆に使ってもらう場合: [「アプリケーションとしてAPIキーを取得する」](#アプリケーションとしてAPIキーを取得する)に進む +* あなた専用の場合: [「自分のアカウントのアクセストークンを取得する」](#自分のアカウントのアクセストークンを取得する)に進む +* 皆に使ってもらう場合: [「アプリケーションとしてアクセストークンを取得する」](#アプリケーションとしてアクセストークンを取得する)に進む -### 自分のアカウントのAPIキーを取得する -「設定 > API」で、自分のAPIキーを取得できます。 +### 自分のアカウントのアクセストークンを取得する +「設定 > API」で、自分のアクセストークンを取得できます。 -> この方法で入手したAPIキーは強力なので、第三者に教えないでください(アプリなどにも入力しないでください)。 +> この方法で入手したアクセストークンは強力なので、第三者に教えないでください(アプリなどにも入力しないでください)。 [「APIの使い方」へ進む](#APIの使い方) -### アプリケーションとしてAPIキーを取得する -アプリケーションを使ってもらうには、ユーザーのAPIキーを以下の手順で取得する必要があります。 +### アプリケーションとしてアクセストークンを取得する +アプリケーションを使ってもらうには、ユーザーのアクセストークンを以下の手順で取得する必要があります。 #### Step 1 @@ -38,23 +38,23 @@ UUIDを生成する。以後これをセッションIDと呼びます。 * `callback` ... 認証が終わった後にリダイレクトするURL * > 例: `https://missdeck.example.com/callback` * リダイレクト時には、`session`というクエリパラメータでセッションIDが付きます -* `permissions` ... アプリケーションが要求する権限 +* `permission` ... アプリケーションが要求する権限 * > 例: `write:notes,write:following,read:drive` * 要求する権限を`,`で区切って列挙します * どのような権限があるかは[APIリファレンス](/api-doc)で確認できます #### Step 3 -ユーザーが連携を許可した後、`{_URL_}/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてAPIキーを含むJSONが返ります。 +ユーザーが連携を許可した後、`{_URL_}/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。 レスポンスに含まれるプロパティ: -* `token` ... ユーザーのAPIキー +* `token` ... ユーザーのアクセストークン * `user` ... ユーザーの情報 [「APIの使い方」へ進む](#APIの使い方) ## APIの使い方 **APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式です。RESTではありません。** -APIキーは、`i`というパラメータ名でリクエストに含めます。 +アクセストークンは、`i`というパラメータ名でリクエストに含めます。 * [APIリファレンス](/api-doc) * [ストリーミングAPI](./stream) -- cgit v1.2.3-freya