api docs (ja) of Streaming APIs

内容の書き換えが進行中です。

Streaming APIs

---

目次

• Request API
• EventStream API

---

WebSocketプロトコルに従って接続します。
wss://(APIサーバのドメイン名)?access_token=(AccessToken) に接続してください。

やり取りされるデータ(イベントオブジェクト)のフォーマットについて

Streaming APIsは、JSONオブジェクトをWebSocketのUTF-8メッセージとしてやり取りすることによって利用されます。
やり取りされるJSONオブジェクトは、必ず以下の2つのメンバを含んでいる必要があります。
Streaming APIsではこのオブジェクトのことを「イベントオブジェクト」と呼んでいます。

メンバ名	説明
event	利用するAPIに関連付いたイベント名を指定します。(イベント名 と呼ばれます)
data	APIの利用に必要なデータを指定します。(イベントデータ と呼ばれます)

• 例 (Request APIのリクエストの場合)

{
  "event": "request",
  "data": {
    "id": "2",
    "endpoint": "/posting/create-chat",
    "params": {
      "text": "おはようございます"
    }
  }
}

Request API

各エンドポイントへのリクエストをストリーミング上から行えるようにするAPIです。
HTTPリクエストがその都度発生しないため、オーバーヘッドを小さくすることが出来ます。

エンドポイントにリクエストする

イベント名

request

イベントデータ

プロパティ名	型	必須
id	int or string	True
endpoint	string	True
params	object	False

• 例 リクエスト

{
  "event":"request",
  "data": {
    "endpoint":"/posting/create-chat",
    "params": {
        "text": "おはようございます"
    },
    "id": "1"
  }
}

レスポンス

{
  "event": "request",
  "data": {
    "id": "2",
    "success": true,
    "statusCode": 200,
    "resource": {
      "chatPosting": {
        "createdAt": 1542525441,
        "id": "5bf1120154d6cf2a485bcb6e",
        "text": "おはようございます",
        "type": "chat",
        "user": {
          "createdAt": 1500702964,
          "description": "コーヒーが好きです",
          "followersCount": 7,
          "followingsCount": 16,
          "iconFileId": "5a813952bf8f203120a6b189",
          "id": "5972e8f4d61aea367cbf6972",
          "name": "香風智乃",
          "postsCount": {
            "status": 252
          },
          "screenName": "chino123"
        },
        "userId": "5972e8f4d61aea367cbf6972"
      }
    }
  }
}

EventStream API

リアルタイムにタイムラインや通知を受信するためのAPIです。

イベントストリームを購読する

イベント名

eventStream.subscribe

イベントデータ

プロパティ名	型	必須
id	int or string	True
sourceName	string	True

• 例 リクエスト

{
  "event": "eventStream.subscribe",
  "data": {
    "id": "1",
    "sourceName": "homeTimeline"
  }
}

レスポンス

{
  "event": "eventStream.subscribe",
  "data": {
    "success": true,
    "message": "subscribed home timeline"
  }
}

イベントストリームを購読解除する

イベント名

eventStream.unubscribe

イベントデータ

プロパティ名	型	必須
id	int or string	True
sourceName	string	True

• 例 リクエスト

{
  "event": "eventStream.unsubscribe",
  "data": {
    "id": "1",
    "sourceName": "homeTimeline"
  }
}

レスポンス

{
  "event": "eventStream.unsubscribe",
  "data": {
    "success": true,
    "message": "unsubscribed home timeline"
  }
}

[執筆中]