summaryrefslogtreecommitdiff
path: root/src/web/docs/api.ja.pug
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-12-17 14:35:30 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-12-17 14:35:30 +0900
commitd4fb399c95c65e4a6805e02074b8e5cc754a3822 (patch)
tree4901d6b8828aada8275feb4787fcede57eb0bd27 /src/web/docs/api.ja.pug
parentUpdate api.ja.pug (diff)
downloadsharkey-d4fb399c95c65e4a6805e02074b8e5cc754a3822.tar.gz
sharkey-d4fb399c95c65e4a6805e02074b8e5cc754a3822.tar.bz2
sharkey-d4fb399c95c65e4a6805e02074b8e5cc754a3822.zip
なんかもうめっちゃ変えた
Diffstat (limited to 'src/web/docs/api.ja.pug')
-rw-r--r--src/web/docs/api.ja.pug10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/web/docs/api.ja.pug b/src/web/docs/api.ja.pug
index 5514a40975..2584b08581 100644
--- a/src/web/docs/api.ja.pug
+++ b/src/web/docs/api.ja.pug
@@ -7,6 +7,7 @@ section
h2 自分の所有するアカウントからAPIにアクセスする場合
p 「設定 > API」で、APIにアクセスするのに必要なAPIキーを取得してください。
p APIにアクセスする際には、リクエストにAPIキーを「i」というパラメータ名で含めます。
+ div.ui.info.warn: p %fa:exclamation-triangle%アカウントを不正利用される可能性があるため、このトークンは第三者に教えないでください(アプリなどにも入力しないでください)。
p APIの詳しい使用法は「Misskey APIの利用」セクションをご覧ください。
section
@@ -15,7 +16,7 @@ section
| 直接ユーザーのAPIキーをアプリケーションが扱うのは危険なので、
| アプリケーションからAPIを利用する際には、アプリケーションとアプリケーションを利用するユーザーが結び付けられた専用のトークン(アクセストークン)をMisskeyに発行してもらい、
| そのトークンをリクエストのパラメータに含める必要があります。
- | (アクセストークンは、ユーザーが自分のアカウントにあなたのアプリケーションがアクセスすることを許可した場合のみ発行されます)
+ div.ui.info: p %fa:info-circle%アクセストークンは、ユーザーが自分のアカウントにあなたのアプリケーションがアクセスすることを許可した場合のみ発行されます
p それでは、アクセストークンを取得するまでの流れを説明します。
@@ -46,9 +47,8 @@ section
td 権限
td あなたのアプリケーションやWebサービスが要求する権限。ここで要求した機能だけがAPIからアクセスできます。
- p
- | 登録が済むとアプリケーションのシークレットキーが入手できます。このシークレットキーは後で使用します。
- | アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。
+ p 登録が済むとアプリケーションのシークレットキーが入手できます。このシークレットキーは後で使用します。
+ div.ui.info.warn: p %fa:exclamation-triangle%アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。
section
h3 2.ユーザーに認証させる
@@ -93,7 +93,7 @@ section
h2 Misskey APIの利用
p APIはすべてリクエストのパラメータ・レスポンスともにJSON形式です。また、すべてのエンドポイントはPOSTメソッドのみ受け付けます。
p APIリファレンスもご確認ください。
-
+
section
h3 レートリミット
p Misskey APIにはレートリミットがあり、短時間のうちに多数のリクエストを送信すると、一定時間APIを利用することができなくなることがあります。