mirror of
https://iceshrimp.dev/Crimekillz/jointrashposs.git
synced 2024-11-24 17:59:07 +01:00
89 lines
3.4 KiB
Markdown
89 lines
3.4 KiB
Markdown
|
# アクセストークンの取得
|
|||
|
|
|
|||
|
|
APIを使い始めるには、APIを利用するアカウントに紐づいた**アクセストークン**を取得する必要があります。
|
|||
|
|
このドキュメントでは、アクセストークンを取得する手順を説明した後、基本的なAPIの使い方を説明します。
|
|||
|
|
|
|||
|
|
基本的に、APIはリクエストにはアクセストークンが必要となります。
|
|||
|
|
アクセストークンは、ユーザーに紐づいた認証情報で、APIを利用するユーザーを識別するとともに、アクセストークンごとにどういった操作の権限を持っているかが管理されます。
|
|||
|
|
|
|||
|
|
:::tip
|
|||
|
|
|
|||
|
|
ユーザーとそのユーザーに紐づいたアクセストークンは一対多の関係であり、あるユーザーに対して複数のアクセストークンが発行され得ます。
|
|||
|
|
|
|||
|
|
:::
|
|||
|
|
|
|||
|
|
あなた自分自身のアクセストークンは簡単に取得できるほか、あなたのアプリケーションを使用することになる不特定のユーザーのアクセストークンを取得することもできます。
|
|||
|
|
|
|||
|
|
- 前者の場合: **「自分自身のアクセストークンを手動発行する」** に進む
|
|||
|
|
- 後者の場合: **「アプリケーション利用者にアクセストークンの発行をリクエストする」** に進む
|
|||
|
|
|
|||
|
|
## 自分自身のアクセストークンを手動発行する
|
|||
|
|
|
|||
|
|
Misskey Webの「設定 > API」で、自分のアクセストークンを発行できます。
|
|||
|
|
|
|||
|
|
:::danger
|
|||
|
|
|
|||
|
|
アクセストークンは他人に知られないようにしてください。
|
|||
|
|
|
|||
|
|
:::
|
|||
|
|
|
|||
|
|
## アプリケーション利用者にアクセストークンの発行をリクエストする
|
|||
|
|
|
|||
|
|
アプリケーションを利用するユーザー(以下単に「ユーザー」と呼びます)のアクセストークンを取得するには、以下の方法の一つを使います。
|
|||
|
|
|
|||
|
|
:MkIndex
|
|||
|
|
|
|||
|
|
## APIの利用
|
|||
|
|
|
|||
|
|
アクセストークンが取得できたら、各種エンドポイントにリクエストすることでAPIの利用が行えます。
|
|||
|
|
|
|||
|
|
:::tip
|
|||
|
|
|
|||
|
|
- HTTP APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式です（drive/files/createを除く）。
|
|||
|
|
- 要求ヘッダーに`Content-Type: application/json`を指定します。
|
|||
|
|
- アクセストークンは、`i`というパラメータ名でリクエストボディJSONに含めます。
|
|||
|
|
- ベースURLは`https://{サーバーのドメイン}/api`です。
|
|||
|
|
|
|||
|
|
:::
|
|||
|
|
|
|||
|
|
### Authorization headerを使う方式
|
|||
|
|
|
|||
|
|
以下のようにヘッダーの`Authorization`フィールドを指定します。
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
fetch("https://misskey.io/api/notes/create", {
|
|||
|
|
method: 'POST',
|
|||
|
|
body: JSON.stringify({
|
|||
|
|
text: "Hello Misskey API World with My Application!"
|
|||
|
|
}),
|
|||
|
|
headers: {
|
|||
|
|
Authorization: `Bearer ${accessToken}`,
|
|||
|
|
'Content-Type': 'application/json',
|
|||
|
|
},
|
|||
|
|
credentials: 'omit',
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### iを使う方式
|
|||
|
|
|
|||
|
|
アクセストークン付きのボディの例（metaの場合）:
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"i": "HogEFugA1341",
|
|||
|
|
"detail": false
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
<!--TODO:「APIリファレンス」をリンクに差し替え-->
|
|||
|
|
|
|||
|
|
APIの詳細は、APIリファレンスを参照してください。
|
|||
|
|
|
|||
|
|
:::warning
|
|||
|
|
|
|||
|
|
MisskeyはRESTを採用していません。
|
|||
|
|
|
|||
|
|
:::
|
|||
|
|
|
|||
|
|
また、MisskeyはHTTP APIだけでなく、ストリーミングAPIも提供しています。ストリーミングAPIの詳細は[こちらのドキュメント](../streaming/)を参照してください。
|