diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-07-27 03:43:23 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-07-27 03:43:23 +0900 |
| commit | 50327158e25d3266f8d3920645d3db90aa420db3 (patch) | |
| tree | ecbe05dc97920203ae8a54008005f3c92db0a478 /src/docs | |
| parent | :v: (diff) | |
| download | misskey-50327158e25d3266f8d3920645d3db90aa420db3.tar.gz misskey-50327158e25d3266f8d3920645d3db90aa420db3.tar.bz2 misskey-50327158e25d3266f8d3920645d3db90aa420db3.zip | |
wip doc
Diffstat (limited to 'src/docs')
| -rw-r--r-- | src/docs/stream.ja.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/docs/stream.ja.md b/src/docs/stream.ja.md new file mode 100644 index 0000000000..7a2815dba2 --- /dev/null +++ b/src/docs/stream.ja.md @@ -0,0 +1,19 @@ +# ストリーミングAPI + +ストリーミングAPIを使うと、リアルタイムで様々な情報(例えばタイムラインに新しい投稿が流れてきた、メッセージが届いた、フォローされた、など)を受け取ったり、HTTPリクエストを発生させることなくAPIにアクセスしたりすることができます。 + +## ストリームに接続する + +以下のURLに**websocket**接続します。 +``` +%URL% +``` + +接続する際は、`i`というパラメータ名で認証情報を含めます。例: +``` +%URL%/?i=xxxxxxxxxxxxxxx +``` + +## ストリームを経由してAPIリクエストする + +ストリームを経由してAPIリクエストすると、HTTPリクエストを発生させずにAPIを利用できます。 |