summaryrefslogtreecommitdiff
path: root/src/docs/zh-CN/api.md
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2020-12-28 21:45:08 +0900
committerGitHub <noreply@github.com>2020-12-28 21:45:08 +0900
commit498f6e9be2728e961b842053e0c9191ca40274b2 (patch)
tree6a9ae6dd79cd4df886aa461d5a442bf485a2a88c /src/docs/zh-CN/api.md
parent:art: (diff)
downloadmisskey-498f6e9be2728e961b842053e0c9191ca40274b2.tar.gz
misskey-498f6e9be2728e961b842053e0c9191ca40274b2.tar.bz2
misskey-498f6e9be2728e961b842053e0c9191ca40274b2.zip
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)
Diffstat (limited to 'src/docs/zh-CN/api.md')
-rw-r--r--src/docs/zh-CN/api.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/src/docs/zh-CN/api.md b/src/docs/zh-CN/api.md
new file mode 100644
index 0000000000..4a67622e30
--- /dev/null
+++ b/src/docs/zh-CN/api.md
@@ -0,0 +1,58 @@
+# Misskey API
+
+您可以使用Misskey API来开发Misskey客户端、与Misskey链接的Web服务、Bot等应用(以下称为“应用程序”)。 另外还有一个流式API,因此还可以用来创建实时性的应用程序。
+
+开始使用API前​​,您首先需要获取访问令牌。 本文档将引导您完成获取访问令牌的步骤,然后介绍API的基本使用方法。
+
+## 访问令牌的获取
+总的来说,API请求需要访问令牌。 获取方式则根据请求的API或者非特定用户所使用的应用程序而有所不同。
+
+* 对于前者:转到[“手动发放自己的访问令牌”](#自分自身のアクセストークンを手動発行する)
+* 对于后者:转到[“请求应用程序用户发放访问令牌”](#アプリケーション利用者にアクセストークンの発行をリクエストする)
+
+### 手动发放自己的访问令牌
+您可以在“设置 > API”中发放自己的访问令牌。
+
+[转到“API使用方法”](#APIの使い方)
+
+### 请求应用程序用户发放访问令牌
+要获取应用程序用户的访问令牌,请按照以下步骤请求发放。
+
+#### Step 1
+
+生成UUID。以下将其称为会话ID。
+
+> 此会话ID需要每次重新生成,请勿重复使用。
+
+#### Step 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`
+ * 重定向时,会话ID将添加查询参数`session`
+* `permission` ... 应用程序要求的权限
+ * > 例: `write:notes,write:following,read:drive`
+ * 要求的权限需要以`,`分隔
+ * 您可以在[API参考](/api-doc)中确认您所拥有的权限。
+
+#### Step 3
+用户允许发行后,对`{_URL_}/api/miauth/{session}/check`的POST请求所返回的是一个包含访问令牌的JSON格式的响应。
+
+响应中包含的属性:
+* `token` ... 用户的访问令牌
+* `user` ... 用户信息
+
+[转到“API使用方法”](#APIの使い方)
+
+## API使用方法
+**所有API均为POST,并且请求/响应均为JSON格式。不是REST。** 访问令牌包含在请求中,参数名为`i`。
+
+* [API 参考](/api-doc)
+* [流式API](./stream)