misskey/src/docs/zh-TW/api.md
syuilo 498f6e9be2
New Crowdin updates (#6964)
* New translations theme.md (Arabic)

* New translations timelines.md (Arabic)

* New translations aiscript.md (Czech)

* New translations api.md (Czech)

* New translations create-plugin.md (Czech)

* New translations custom-emoji.md (Czech)

* New translations follow.md (Czech)

* New translations keyboard-shortcut.md (Czech)

* New translations timelines.md (Spanish)

* New translations stream.md (Spanish)

* New translations pages.md (Czech)

* New translations theme.md (French)

* New translations api.md (French)

* New translations create-plugin.md (French)

* New translations custom-emoji.md (French)

* New translations follow.md (French)

* New translations keyboard-shortcut.md (French)

* New translations mute.md (French)

* New translations pages.md (French)

* New translations reaction.md (French)

* New translations reversi-bot.md (French)

* New translations stream.md (French)

* New translations create-plugin.md (Dutch)

* New translations reversi-bot.md (Spanish)

* New translations aiscript.md (Spanish)

* New translations api.md (Spanish)

* New translations create-plugin.md (Spanish)

* New translations custom-emoji.md (Spanish)

* New translations follow.md (Spanish)

* New translations keyboard-shortcut.md (Spanish)

* New translations mute.md (Spanish)

* New translations pages.md (Spanish)

* New translations reaction.md (Spanish)

* New translations mute.md (Czech)

* New translations timelines.md (French)

* New translations reaction.md (Czech)

* New translations follow.md (Korean)

* New translations reaction.md (German)

* New translations reversi-bot.md (German)

* New translations stream.md (German)

* New translations theme.md (German)

* New translations timelines.md (German)

* New translations aiscript.md (Korean)

* New translations api.md (Korean)

* New translations create-plugin.md (Korean)

* New translations custom-emoji.md (Korean)

* New translations keyboard-shortcut.md (Korean)

* New translations mute.md (German)

* New translations mute.md (Korean)

* New translations pages.md (Korean)

* New translations reaction.md (Korean)

* New translations stream.md (Korean)

* New translations theme.md (Korean)

* New translations timelines.md (Korean)

* New translations aiscript.md (Dutch)

* New translations api.md (Dutch)

* New translations reversi-bot.md (Czech)

* New translations pages.md (German)

* New translations reversi-bot.md (Korean)

* New translations keyboard-shortcut.md (German)

* New translations mute.md (Danish)

* New translations stream.md (Czech)

* New translations follow.md (German)

* New translations theme.md (Czech)

* New translations timelines.md (Czech)

* New translations api.md (Danish)

* New translations create-plugin.md (Danish)

* New translations custom-emoji.md (Danish)

* New translations follow.md (Danish)

* New translations keyboard-shortcut.md (Danish)

* New translations aiscript.md (Danish)

* New translations pages.md (Danish)

* New translations ja-JP.yml (German)

* New translations reaction.md (Danish)

* New translations custom-emoji.md (German)

* New translations api.md (German)

* New translations aiscript.md (German)

* New translations timelines.md (Danish)

* New translations theme.md (Danish)

* New translations stream.md (Danish)

* New translations reversi-bot.md (Danish)

* New translations create-plugin.md (German)

* New translations follow.md (Kabyle)

* New translations keyboard-shortcut.md (Kabyle)

* New translations custom-emoji.md (Kabyle)

* New translations create-plugin.md (Kabyle)

* New translations api.md (Kabyle)

* New translations aiscript.md (Kabyle)

* New translations reversi-bot.md (Kannada)

* New translations timelines.md (Kannada)

* New translations theme.md (Kannada)

* New translations stream.md (Kannada)

* New translations reaction.md (Kannada)

* New translations pages.md (Kannada)

* New translations mute.md (Kannada)

* New translations pages.md (Kabyle)

* New translations keyboard-shortcut.md (Kannada)

* New translations mute.md (Kabyle)

* New translations keyboard-shortcut.md (Japanese, Kansai)

* New translations reaction.md (Kabyle)

* New translations follow.md (Japanese, Kansai)

* New translations custom-emoji.md (Kannada)

* New translations theme.md (Japanese, Kansai)

* New translations stream.md (Japanese, Kansai)

* New translations reversi-bot.md (Japanese, Kansai)

* New translations reaction.md (Japanese, Kansai)

* New translations pages.md (Japanese, Kansai)

* New translations mute.md (Japanese, Kansai)

* New translations custom-emoji.md (Japanese, Kansai)

* New translations reversi-bot.md (Kabyle)

* New translations create-plugin.md (Japanese, Kansai)

* New translations api.md (Japanese, Kansai)

* New translations aiscript.md (Japanese, Kansai)

* New translations timelines.md (Kabyle)

* New translations theme.md (Kabyle)

* New translations stream.md (Kabyle)

* New translations follow.md (Kannada)

* New translations keyboard-shortcut.md (English)

* New translations create-plugin.md (Kannada)

* New translations aiscript.md (English)

* New translations reaction.md (English)

* New translations pages.md (English)

* New translations mute.md (English)

* New translations follow.md (English)

* New translations custom-emoji.md (English)

* New translations create-plugin.md (English)

* New translations api.md (English)

* New translations stream.md (English)

* New translations timelines.md (Chinese Traditional)

* New translations theme.md (Chinese Traditional)

* New translations stream.md (Chinese Traditional)

* New translations reversi-bot.md (Chinese Traditional)

* New translations reaction.md (Chinese Traditional)

* New translations pages.md (Chinese Traditional)

* New translations mute.md (Chinese Traditional)

* New translations reversi-bot.md (English)

* New translations theme.md (English)

* New translations api.md (Kannada)

* New translations pages.md (Uyghur)

* New translations aiscript.md (Kannada)

* New translations timelines.md (Uyghur)

* New translations theme.md (Uyghur)

* New translations stream.md (Uyghur)

* New translations reversi-bot.md (Uyghur)

* New translations reaction.md (Uyghur)

* New translations mute.md (Uyghur)

* New translations timelines.md (English)

* New translations keyboard-shortcut.md (Uyghur)

* New translations follow.md (Uyghur)

* New translations custom-emoji.md (Uyghur)

* New translations create-plugin.md (Uyghur)

* New translations api.md (Uyghur)

* New translations aiscript.md (Uyghur)

* New translations timelines.md (Japanese, Kansai)

* New translations ja-JP.yml (Chinese Simplified)

* New translations ja-JP.yml (French)

* New translations ja-JP.yml (Chinese Simplified)

* New translations ja-JP.yml (Chinese Traditional)

* New translations ja-JP.yml (English)

* New translations ja-JP.yml (Russian)

* New translations ja-JP.yml (Ukrainian)

* New translations ja-JP.yml (Spanish)

* New translations ja-JP.yml (German)

* New translations ja-JP.yml (Korean)

* New translations aiscript.md (Chinese Simplified)

* New translations api.md (Chinese Simplified)

* New translations api.md (Chinese Simplified)

* New translations api.md (Chinese Simplified)

* New translations api.md (Chinese Simplified)

* New translations api.md (Chinese Simplified)

* New translations api.md (Chinese Simplified)

* New translations api.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations stream.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations ja-JP.yml (Chinese Traditional)

* New translations ja-JP.yml (Chinese Traditional)

* New translations mfm.md (Ukrainian)

* New translations mfm.md (Korean)

* New translations deck.md (Dutch)

* New translations mfm.md (Dutch)

* New translations deck.md (Norwegian)

* New translations mfm.md (Norwegian)

* New translations deck.md (Polish)

* New translations mfm.md (Polish)

* New translations deck.md (Portuguese)

* New translations mfm.md (Portuguese)

* New translations deck.md (Russian)

* New translations mfm.md (Russian)

* New translations deck.md (Ukrainian)

* New translations deck.md (Chinese Simplified)

* New translations mfm.md (German)

* New translations mfm.md (Chinese Simplified)

* New translations deck.md (Chinese Traditional)

* New translations mfm.md (Chinese Traditional)

* New translations deck.md (English)

* New translations mfm.md (English)

* New translations deck.md (Uyghur)

* New translations mfm.md (Uyghur)

* New translations deck.md (Kannada)

* New translations mfm.md (Kannada)

* New translations deck.md (Kabyle)

* New translations mfm.md (Kabyle)

* New translations deck.md (Japanese, Kansai)

* New translations deck.md (Korean)

* New translations deck.md (German)

* New translations mfm.md (Danish)

* New translations deck.md (French)

* New translations mfm.md (French)

* New translations deck.md (Spanish)

* New translations mfm.md (Spanish)

* New translations deck.md (Arabic)

* New translations mfm.md (Arabic)

* New translations deck.md (Czech)

* New translations mfm.md (Czech)

* New translations deck.md (Danish)

* New translations mfm.md (Japanese, Kansai)

* New translations aiscript.md (Chinese Traditional)

* New translations api.md (Chinese Traditional)

* New translations timelines.md (Chinese Traditional)

* New translations api.md (Chinese Traditional)

* New translations api.md (Chinese Traditional)

* New translations api.md (Chinese Traditional)

* New translations create-plugin.md (Chinese Traditional)

* New translations keyboard-shortcut.md (Chinese Traditional)

* New translations stream.md (Chinese Traditional)

* New translations keyboard-shortcut.md (Chinese Traditional)

* New translations keyboard-shortcut.md (Chinese Traditional)

* New translations create-plugin.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations create-plugin.md (Chinese Simplified)

* New translations aiscript.md (Chinese Traditional)

* New translations follow.md (Chinese Traditional)

* New translations ja-JP.yml (Chinese Traditional)

* New translations follow.md (Chinese Traditional)

* New translations ja-JP.yml (Chinese Traditional)

* New translations create-plugin.md (Chinese Simplified)

* New translations ja-JP.yml (Chinese Traditional)

* New translations create-plugin.md (Chinese Simplified)

* New translations custom-emoji.md (Chinese Simplified)

* New translations ja-JP.yml (Chinese Traditional)

* New translations ja-JP.yml (Chinese Simplified)

* New translations ja-JP.yml (Chinese Traditional)

* New translations ja-JP.yml (Chinese Traditional)

* New translations ja-JP.yml (Chinese Traditional)

* New translations ja-JP.yml (Chinese Traditional)
2020-12-28 21:45:08 +09:00

3.3 KiB
Raw Blame History

Misskey API

使用MisskeyAPI以開發Misskey客戶端、Misskey連接的網路服務平台及機器人等以下簡稱 「應用程式」)。 此外還有串流媒體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リファレンスで確認できます

步驟3

ユーザーが発行を許可した後、{_URL_}/api/miauth/{session}/checkにPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。

レスポンスに含まれるプロパティ:

  • token ... ユーザーのアクセストークン
  • user ... ユーザーの情報

「APIの使い方」へ進む

API使用方法

APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式です。RESTではありません。 アクセストークンは、iというパラメータ名でリクエストに含めます。