diff options
| author | syuilo <Syuilotan@yahoo.co.jp> | 2021-10-16 19:27:06 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-16 19:27:06 +0900 |
| commit | 0d306e9d410d87148a58b6aad4302da18e0c1506 (patch) | |
| tree | 5fd245df50ac3a6112eb13cfc480cab068e30134 /src/docs/en-US/advanced/api.md | |
| parent | :art: (diff) | |
| download | misskey-0d306e9d410d87148a58b6aad4302da18e0c1506.tar.gz misskey-0d306e9d410d87148a58b6aad4302da18e0c1506.tar.bz2 misskey-0d306e9d410d87148a58b6aad4302da18e0c1506.zip | |
New Crowdin updates (#7824)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Korean)
* New translations ja-JP.yml (Chinese Simplified)
* New translations ja-JP.yml (Chinese Simplified)
* New translations create-plugin.md (Esperanto)
* New translations keyboard-shortcut.md (Esperanto)
* New translations faq.md (Esperanto)
* New translations misskey.md (Esperanto)
* New translations stream.md (Esperanto)
* New translations favorite.md (Esperanto)
* New translations faq.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations keyboard-shortcut.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations keyboard-shortcut.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (French)
* New translations ja-JP.yml (French)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (English)
* New translations api.md (English)
* New translations aiscript.md (English)
* New translations create-plugin.md (English)
* New translations stream.md (English)
* New translations create-plugin.md (English)
* New translations develop-bot.md (English)
* New translations ja-JP.yml (Spanish)
* New translations ja-JP.yml (Spanish)
* New translations ja-JP.yml (Spanish)
* New translations ja-JP.yml (Spanish)
* New translations ja-JP.yml (Spanish)
* New translations ja-JP.yml (Spanish)
* New translations troubleshooting.md (Spanish)
* New translations glossary.md (Esperanto)
* New translations glossary.md (Esperanto)
* New translations glossary.md (Esperanto)
* New translations glossary.md (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (Chinese Simplified)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Russian)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations mfm.md (Esperanto)
* New translations mfm.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Russian)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Russian)
* New translations note.md (Esperanto)
* New translations note.md (Esperanto)
* New translations ja-JP.yml (Arabic)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (Chinese Simplified)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (Chinese Simplified)
* New translations ja-JP.yml (French)
* New translations ja-JP.yml (French)
* New translations ja-JP.yml (French)
* New translations ja-JP.yml (French)
* New translations ja-JP.yml (Russian)
* New translations ja-JP.yml (Korean)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (Indonesian)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Russian)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (English)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (French)
* New translations ja-JP.yml (French)
* New translations glossary.md (French)
* New translations troubleshooting.md (French)
* New translations troubleshooting.md (French)
* New translations troubleshooting.md (French)
* New translations troubleshooting.md (French)
* New translations troubleshooting.md (French)
* New translations troubleshooting.md (French)
* New translations troubleshooting.md (French)
* New translations ja-JP.yml (French)
* New translations troubleshooting.md (French)
* New translations troubleshooting.md (English)
* New translations ja-JP.yml (Italian)
* New translations note.md (Esperanto)
* New translations glossary.md (French)
* New translations apps.md (French)
* New translations ja-JP.yml (French)
* New translations note.md (Esperanto)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations ja-JP.yml (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (English)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations glossary.md (French)
* New translations ja-JP.yml (French)
* New translations glossary.md (French)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations ja-JP.yml (Esperanto)
* New translations glossary.md (Esperanto)
* New translations api.md (English)
* New translations create-plugin.md (English)
* New translations ja-JP.yml (German)
* New translations ja-JP.yml (English)
* 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 ja-JP.yml (Chinese Simplified)
* New translations stream.md (Chinese Simplified)
* New translations follow.md (Chinese Simplified)
* New translations mfm.md (Chinese Simplified)
* New translations mfm.md (Chinese Simplified)
Diffstat (limited to 'src/docs/en-US/advanced/api.md')
| -rw-r--r-- | src/docs/en-US/advanced/api.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/src/docs/en-US/advanced/api.md b/src/docs/en-US/advanced/api.md index 76019b6145..ef1995b18e 100644 --- a/src/docs/en-US/advanced/api.md +++ b/src/docs/en-US/advanced/api.md @@ -4,7 +4,7 @@ MisskeyAPIを使ってMisskeyクライアント、Misskey連携Webサービス APIを使い始めるには、まずアクセストークンを取得する必要があります。 このドキュメントでは、アクセストークンを取得する手順を説明した後、基本的なAPIの使い方を説明します。 -## アクセストークンの取得 +## Obtain an access token 基本的に、APIはリクエストにはアクセストークンが必要となります。 APIにリクエストするのが自分自身なのか、不特定の利用者に使ってもらうアプリケーションなのかによって取得手順は異なります。 * 前者の場合: [「自分自身のアクセストークンを手動発行する」](#自分自身のアクセストークンを手動発行する)に進む @@ -20,7 +20,7 @@ APIを使い始めるには、まずアクセストークンを取得する必 #### Step 1 -UUIDを生成する。以後これをセッションIDと呼びます。 +Generate UUID.以後これをセッションIDと呼びます。 > このセッションIDは毎回生成し、使いまわさないようにしてください。 @@ -30,14 +30,14 @@ UUIDを生成する。以後これをセッションIDと呼びます。 > 例: `{_URL_}/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f` 表示する際、URLにクエリパラメータとしていくつかのオプションを設定できます: -* `name` ... アプリケーション名 +* `name` ... App name * > 例: `MissDeck` -* `icon` ... アプリケーションのアイコン画像URL +* `icon` ... App icon URL * > 例: `https://missdeck.example.com/icon.png` * `callback` ... 認証が終わった後にリダイレクトするURL * > 例: `https://missdeck.example.com/callback` * リダイレクト時には、`session`というクエリパラメータでセッションIDが付きます -* `permission` ... アプリケーションが要求する権限 +* `permission` ... App permissions * > 例: `write:notes,write:following,read:drive` * 要求する権限を`,`で区切って列挙します * どのような権限があるかは[APIリファレンス](/api-doc)で確認できます @@ -46,13 +46,13 @@ UUIDを生成する。以後これをセッションIDと呼びます。 ユーザーが発行を許可した後、`{_URL_}/api/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。 レスポンスに含まれるプロパティ: -* `token` ... ユーザーのアクセストークン -* `user` ... ユーザーの情報 +* `token` ... User access token +* `user` ... User info [「APIの使い方」へ進む](#APIの使い方) -## APIの使い方 -**APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式です。RESTではありません。** アクセストークンは、`i`というパラメータ名でリクエストに含めます。 +## API usage +**APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式です。There is no REST support.** アクセストークンは、`i`というパラメータ名でリクエストに含めます。 -* [APIリファレンス](/api-doc) -* [ストリーミングAPI](./stream) +* [API Reference](/api-doc) +* [Streaming API](./stream) |