Sharkey/src/docs/stream.ja.md
2018-07-27 03:43:23 +09:00

770 B

ストリーミングAPI

ストリーミングAPIを使うと、リアルタイムで様々な情報(例えばタイムラインに新しい投稿が流れてきた、メッセージが届いた、フォローされた、など)を受け取ったり、HTTPリクエストを発生させることなくAPIにアクセスしたりすることができます。

ストリームに接続する

以下のURLにwebsocket接続します。

%URL%

接続する際は、iというパラメータ名で認証情報を含めます。例:

%URL%/?i=xxxxxxxxxxxxxxx

ストリームを経由してAPIリクエストする

ストリームを経由してAPIリクエストすると、HTTPリクエストを発生させずにAPIを利用できます。