From 608b8bb74142c52e78f53afc1bbc340b85dfa2d4 Mon Sep 17 00:00:00 2001 From: syuilo Date: Fri, 27 Mar 2020 20:24:32 +0900 Subject: wip --- src/server/api/openapi/description.ts | 47 +---------------------------------- 1 file changed, 1 insertion(+), 46 deletions(-) (limited to 'src/server/api') diff --git a/src/server/api/openapi/description.ts b/src/server/api/openapi/description.ts index a4b79d9502..4fff53ac90 100644 --- a/src/server/api/openapi/description.ts +++ b/src/server/api/openapi/description.ts @@ -42,52 +42,7 @@ export function getDescription(lang = 'ja-JP'): string { .join('\n'); const descriptions = { - 'ja-JP': `**Misskey is a decentralized microblogging platform.** - -# Usage -**APIはすべてPOSTでリクエスト/レスポンスともにJSON形式です。** -一部のAPIはリクエストに認証情報(APIキー)が必要です。リクエストの際に\`i\`というパラメータでAPIキーを添付してください。 - -## 自分のアカウントのAPIキーを取得する -「設定 > API」で、自分のAPIキーを取得できます。 - -> アカウントを不正利用される可能性があるため、このトークンは第三者に教えないでください(アプリなどにも入力しないでください)。 - -## アプリケーションとしてAPIキーを取得する -直接ユーザーのAPIキーをアプリケーションが扱うのはセキュリティ上のリスクがあるので、 -アプリケーションからAPIを利用する際には、アプリケーションとアプリケーションを利用するユーザーが結び付けられた専用のAPIキーを発行します。 - -### 1.アプリケーションを登録する -まず、あなたのアプリケーションやWebサービス(以後、あなたのアプリと呼びます)をMisskeyに登録します。 -[デベロッパーセンター](/dev)にアクセスし、「アプリ > アプリ作成」からアプリを作成してください。 - -登録が済むとあなたのアプリのシークレットキーが入手できます。このシークレットキーは後で使用します。 - -> アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。

- -### 2.ユーザーに認証させる -アプリを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。 - -認証セッションを開始するには、[${config.apiUrl}/auth/session/generate](#operation/auth/session/generate) へパラメータに\`appSecret\`としてシークレットキーを含めたリクエストを送信します。 -レスポンスとして認証セッションのトークンや認証フォームのURLが取得できるので、認証フォームのURLをブラウザで表示し、ユーザーにフォームを提示してください。 - -あなたのアプリがコールバックURLを設定している場合、 -ユーザーがあなたのアプリの連携を許可すると設定しているコールバックURLに\`token\`という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。 - -あなたのアプリがコールバックURLを設定していない場合、ユーザーがあなたのアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。 - -### 3.アクセストークンを取得する -ユーザーが連携を許可したら、[${config.apiUrl}/auth/session/userkey](#operation/auth/session/userkey) へリクエストを送信します。 - -上手くいけば、認証したユーザーのアクセストークンがレスポンスとして取得できます。おめでとうございます！ - -アクセストークンが取得できたら、*「ユーザーのアクセストークン+あなたのアプリのシークレットキーをsha256したもの」*をAPIキーとして、APIにリクエストできます。 - -APIキーの生成方法を擬似コードで表すと次のようになります: -\`\`\` js -const i = sha256(userToken + secretKey); -\`\`\` - + 'ja-JP': ` # Permissions |Permisson (kind)|Description|Endpoints| |:--|:--|:--| -- cgit v1.2.3-freya