summaryrefslogtreecommitdiff
path: root/src/docs/api.ja-JP.md
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2020-03-27 20:24:32 +0900
committersyuilo <syuilotan@yahoo.co.jp>2020-03-27 20:24:32 +0900
commit608b8bb74142c52e78f53afc1bbc340b85dfa2d4 (patch)
tree2823faebba075997bd0af603313c65a409cff79b /src/docs/api.ja-JP.md
parent12.26.0 (diff)
downloadsharkey-608b8bb74142c52e78f53afc1bbc340b85dfa2d4.tar.gz
sharkey-608b8bb74142c52e78f53afc1bbc340b85dfa2d4.tar.bz2
sharkey-608b8bb74142c52e78f53afc1bbc340b85dfa2d4.zip
wip
Diffstat (limited to 'src/docs/api.ja-JP.md')
-rw-r--r--src/docs/api.ja-JP.md59
1 files changed, 58 insertions, 1 deletions
diff --git a/src/docs/api.ja-JP.md b/src/docs/api.ja-JP.md
index 6e1eba0656..5d370a29cd 100644
--- a/src/docs/api.ja-JP.md
+++ b/src/docs/api.ja-JP.md
@@ -1,3 +1,60 @@
# Misskey API
-[APIリファレンス](/api-doc)
+MisskeyAPIを使ってMisskeyクライアント、Misskey連携Webサービス、Bot等(以下「アプリケーション」と呼びます)を開発できます。
+ストリーミングAPIもあるので、リアルタイム性のあるアプリケーションを作ることも可能です。
+
+APIを使い始めるには、まずAPIキーを取得する必要があります。
+このドキュメントでは、APIキーを取得する手順を説明した後、基本的なAPIの使い方を説明します。
+
+## APIキーの取得
+基本的に、APIはリクエストにはAPIキーが必要となります。
+あなたの作ろうとしているアプリケーションが、あなた専用のものなのか、それとも不特定多数の人に使ってもらうものなのかによって、APIキーの取得手順は異なります。
+
+* あなた専用の場合: [「自分のアカウントのAPIキーを取得する」](#自分のアカウントのAPIキーを取得する)に進む
+* 皆に使ってもらう場合: [「アプリケーションとしてAPIキーを取得する」](#アプリケーションとしてAPIキーを取得する)に進む
+
+### 自分のアカウントのAPIキーを取得する
+「設定 > API」で、自分のAPIキーを取得できます。
+
+> この方法で入手したAPIキーは強力なので、第三者に教えないでください(アプリなどにも入力しないでください)。
+
+[「APIの使い方」へ進む](#APIの使い方)
+
+### アプリケーションとしてAPIキーを取得する
+アプリケーションを使ってもらうには、ユーザーのAPIキーを以下の手順で取得する必要があります。
+
+#### Step 1
+
+UUIDを生成する。以後これをセッションIDと呼びます。
+
+#### Step 2
+
+`{_URL_}/miauth/{session}`をユーザーのブラウザで表示させる。`{session}`の部分は、セッションIDに置き換えてください。
+> 例: `{_URL_}/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f`
+
+表示する際、URLにクエリパラメータとしていくつかのオプションを設定できます:
+* `name` ... アプリケーション名
+ * > 例: `MissDeck`
+* `callback` ... 認証が終わった後にリダイレクトするURL
+ * > 例: `https://missdeck.example.com/callback`
+ * リダイレクト時には、`session`というクエリパラメータでセッションIDが付きます
+* `permissions` ... アプリケーションが要求する権限
+ * > 例: `write:notes,write:following,read:drive`
+ * 要求する権限を`,`で区切って列挙します
+ * どのような権限があるかは[APIリファレンス](/api-doc)で確認できます
+
+#### Step 3
+ユーザーが連携を許可した後、`{_URL_}/miauth/{session}/check`にPOSTリクエストすると、レスポンスとしてAPIキーを含むJSONが返ります。
+
+レスポンスに含まれるプロパティ:
+* `token` ... ユーザーのAPIキー
+* `user` ... ユーザーの情報
+
+[「APIの使い方」へ進む](#APIの使い方)
+
+## APIの使い方
+**APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式です。RESTではありません。**
+APIキーは、`i`というパラメータ名でリクエストに含めます。
+
+* [APIリファレンス](/api-doc)
+* [ストリーミングAPI](./stream)