mirror of
https://iceshrimp.dev/iceshrimp/iceshrimp
synced 2025-01-08 06:32:52 +09:00
785ce321c7
* New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations follow.md (Italian) * New translations ja-JP.yml (Italian) * New translations timelines.md (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations create-plugin.md (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations theme.md (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations reaction.md (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Chinese Traditional) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Ukrainian) * New translations api.md (Ukrainian) * New translations ja-JP.yml (Ukrainian) * New translations ja-JP.yml (Ukrainian) * New translations api.md (Ukrainian) * New translations api.md (Ukrainian) * New translations create-plugin.md (Ukrainian) * New translations stream.md (Ukrainian) * New translations api.md (Ukrainian) * New translations create-plugin.md (Ukrainian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Indonesian) * New translations ja-JP.yml (Italian) * New translations pages.md (Italian) * New translations timelines.md (Italian) * New translations ja-JP.yml (Indonesian) * New translations follow.md (Indonesian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Indonesian) * New translations ja-JP.yml (Italian) * New translations stream.md (Italian) * New translations ja-JP.yml (Indonesian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations aiscript.md (Italian) * New translations theme.md (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations theme.md (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Japanese, Kansai) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (French) * New translations ja-JP.yml (Kannada) * New translations ja-JP.yml (Japanese, Kansai) * New translations ja-JP.yml (Kabyle) * New translations ja-JP.yml (Chinese Traditional) * New translations ja-JP.yml (English) * New translations ja-JP.yml (Chinese Simplified) * New translations ja-JP.yml (Indonesian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Korean) * New translations ja-JP.yml (German) * New translations ja-JP.yml (Spanish) * New translations ja-JP.yml (Arabic) * New translations ja-JP.yml (Russian) * New translations ja-JP.yml (Ukrainian) * New translations ja-JP.yml (Polish) * New translations ja-JP.yml (German) * New translations ja-JP.yml (English) * New translations ja-JP.yml (German) * New translations ja-JP.yml (German) * New translations ja-JP.yml (English) * New translations create-plugin.md (English) * New translations ja-JP.yml (Russian) * New translations ja-JP.yml (Russian) * New translations ja-JP.yml (French) * New translations ja-JP.yml (Kannada) * New translations ja-JP.yml (Japanese, Kansai) * New translations ja-JP.yml (Chinese Traditional) * New translations ja-JP.yml (English) * New translations ja-JP.yml (Chinese Simplified) * New translations ja-JP.yml (Indonesian) * New translations ja-JP.yml (Italian) * New translations ja-JP.yml (Korean) * New translations ja-JP.yml (German) * New translations ja-JP.yml (Spanish) * New translations ja-JP.yml (Arabic) * New translations ja-JP.yml (Russian) * New translations ja-JP.yml (Ukrainian) * New translations ja-JP.yml (Polish) * New translations ja-JP.yml (Chinese Simplified) * New translations ja-JP.yml (Ukrainian) * New translations ja-JP.yml (Korean)
59 lines
3.6 KiB
Markdown
59 lines
3.6 KiB
Markdown
# Misskey API
|
||
|
||
MisskeyAPIを使ってMisskeyクライアント、Misskey連携Webサービス、Bot等(以下「アプリケーション」と呼びます)を開発できます。 ストリーミングAPIもあるので、リアルタイム性のあるアプリケーションを作ることも可能です。
|
||
|
||
APIを使い始めるには、まずアクセストークンを取得する必要があります。 このドキュメントでは、アクセストークンを取得する手順を説明した後、基本的なAPIの使い方を説明します。
|
||
|
||
## アクセストークンの取得
|
||
基本的に、APIはリクエストにはアクセストークンが必要となります。 APIにリクエストするのが自分自身なのか、不特定の利用者に使ってもらうアプリケーションなのかによって取得手順は異なります。
|
||
|
||
* 前者の場合: [「自分自身のアクセストークンを手動発行する」](#自分自身のアクセストークンを手動発行する)に進む
|
||
* 後者の場合: [「アプリケーション利用者にアクセストークンの発行をリクエストする」](#アプリケーション利用者にアクセストークンの発行をリクエストする)に進む
|
||
|
||
### 自分自身のアクセストークンを手動発行する
|
||
「設定 > API」で、自分のアクセストークンを発行できます。
|
||
|
||
[「APIの使い方」へ進む](#APIの使い方)
|
||
|
||
### アプリケーション利用者にアクセストークンの発行をリクエストする
|
||
アプリケーション利用者のアクセストークンを取得するには、以下の手順で発行をリクエストします。
|
||
|
||
#### Крок 1
|
||
|
||
Створити UUID.以後これをセッションIDと呼びます。
|
||
|
||
> このセッションIDは毎回生成し、使いまわさないようにしてください。
|
||
|
||
#### Крок 2
|
||
|
||
`{_URL_}/miauth/{session}`をユーザーのブラウザで表示させる。`{session}`の部分は、セッションIDに置き換えてください。
|
||
> 例: `{_URL_}/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f`
|
||
|
||
表示する際、URLにクエリパラメータとしていくつかのオプションを設定できます:
|
||
* `name` ... Назва додатка
|
||
* > 例: `MissDeck`
|
||
* `icon` ... URL піктограми додатка
|
||
* > 例: `https://missdeck.example.com/icon.png`
|
||
* `callback` ... 認証が終わった後にリダイレクトするURL
|
||
* > 例: `https://missdeck.example.com/callback`
|
||
* リダイレクト時には、`session`というクエリパラメータでセッションIDが付きます
|
||
* `permission` ... アプリケーションが要求する権限
|
||
* > 例: `write:notes,write:following,read:drive`
|
||
* 要求する権限を`,`で区切って列挙します
|
||
* どのような権限があるかは[APIリファレンス](/api-doc)で確認できます
|
||
|
||
#### Крок 3
|
||
ユーザーが発行を許可した後、`{_URL_}/api/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
|
||
|
||
レスポンスに含まれるプロパティ:
|
||
* `token` ... ユーザーのアクセストークン
|
||
* `user` ... ユーザーの情報
|
||
|
||
[「APIの使い方」へ進む](#APIの使い方)
|
||
|
||
## Використання API
|
||
**APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式です。Підтримка REST відсутня.** アクセストークンは、`i`というパラメータ名でリクエストに含めます。
|
||
|
||
* [Довідник API](/api-doc)
|
||
* [Потокове API](./stream)
|