49 lines
3.7 KiB
TypeScript
49 lines
3.7 KiB
TypeScript
import config from '../../../config';
|
|
|
|
export const description = `
|
|
## Usage
|
|
**APIはすべてPOSTでリクエスト/レスポンスともにJSON形式です。**
|
|
一部のAPIは認証情報(アクセストークン)が必要です。リクエストの際に\`i\`というパラメータでアクセストークンを添付してください。
|
|
|
|
### 自分のアカウントのアクセストークンを取得する
|
|
「設定 > API」で、自分のアクセストークンを取得できます。
|
|
|
|
> アカウントを不正利用される可能性があるため、このトークンは第三者に教えないでください(アプリなどにも入力しないでください)。
|
|
|
|
### アプリケーションとしてアクセストークンを取得する
|
|
直接ユーザーのアクセストークンをアプリケーションが扱うのはセキュリティ上のリスクがあるので、
|
|
アプリケーションからAPIを利用する際には、アプリケーションとアプリケーションを利用するユーザーが結び付けられた専用のアクセストークンをMisskeyに発行してもらいます。
|
|
|
|
#### 1.アプリケーションを登録する
|
|
まず、あなたのアプリケーションやWebサービス(以後、あなたのアプリと呼びます)をMisskeyに登録します。
|
|
[デベロッパーセンター](/dev)にアクセスし、「アプリ > アプリ作成」からアプリを作成してください。
|
|
|
|
登録が済むとあなたのアプリのシークレットキーが入手できます。このシークレットキーは後で使用します。
|
|
|
|
> アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。</p>
|
|
|
|
#### 2.ユーザーに認証させる
|
|
アプリを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。
|
|
|
|
認証セッションを開始するには、[${config.api_url}/auth/session/generate](#operation/auth/session/generate) へパラメータに appSecret としてシークレットキーを含めたリクエストを送信します。
|
|
リクエスト形式はJSONで、メソッドはPOSTです。
|
|
レスポンスとして認証セッションのトークンや認証フォームのURLが取得できるので、認証フォームのURLをブラウザで表示し、ユーザーにフォームを提示してください。
|
|
|
|
あなたのアプリがコールバックURLを設定している場合、
|
|
ユーザーがあなたのアプリの連携を許可すると設定しているコールバックURLに\`token\`という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
|
|
|
|
あなたのアプリがコールバックURLを設定していない場合、ユーザーがあなたのアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。
|
|
|
|
#### 3.ユーザートークンを取得する
|
|
ユーザーが連携を許可したら、[${config.api_url}/auth/session/userkey](#operation/auth/session/userkey) へリクエストを送信します。
|
|
|
|
上手くいけば、認証したユーザーのユーザートークンがレスポンスとして取得できます。おめでとうございます！
|
|
|
|
ユーザートークンが取得できたら、*「ユーザーのユーザートークン+あなたのアプリのシークレットキーをsha256したもの」*をアクセストークンとして、APIにリクエストできます。
|
|
|
|
アクセストークンの生成方法を擬似コードで表すと次のようになります:
|
|
\`\`\` js
|
|
const i = sha256(userToken + secretKey);
|
|
\`\`\`
|
|
`;
|