forked from FoundKeyGang/FoundKey
wip doc
This commit is contained in:
parent
a99756ef85
commit
50327158e2
1 changed files with 19 additions and 0 deletions
19
src/docs/stream.ja.md
Normal file
19
src/docs/stream.ja.md
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
# ストリーミングAPI
|
||||||
|
|
||||||
|
ストリーミングAPIを使うと、リアルタイムで様々な情報(例えばタイムラインに新しい投稿が流れてきた、メッセージが届いた、フォローされた、など)を受け取ったり、HTTPリクエストを発生させることなくAPIにアクセスしたりすることができます。
|
||||||
|
|
||||||
|
## ストリームに接続する
|
||||||
|
|
||||||
|
以下のURLに**websocket**接続します。
|
||||||
|
```
|
||||||
|
%URL%
|
||||||
|
```
|
||||||
|
|
||||||
|
接続する際は、`i`というパラメータ名で認証情報を含めます。例:
|
||||||
|
```
|
||||||
|
%URL%/?i=xxxxxxxxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
## ストリームを経由してAPIリクエストする
|
||||||
|
|
||||||
|
ストリームを経由してAPIリクエストすると、HTTPリクエストを発生させずにAPIを利用できます。
|
Loading…
Reference in a new issue