From c5d2c32ed24a559ffcd0d2fee4807582feeb6582 Mon Sep 17 00:00:00 2001 From: syuilo Date: Fri, 27 Jul 2018 03:43:23 +0900 Subject: [PATCH] wip doc --- src/docs/stream.ja.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 src/docs/stream.ja.md diff --git a/src/docs/stream.ja.md b/src/docs/stream.ja.md new file mode 100644 index 000000000..7a2815dba --- /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を利用できます。