-
Notifications
You must be signed in to change notification settings - Fork 1
api docs (ja) of Streaming APIs
Frost-API v1.0の仕様に合わせて内容の変更が進行中です。v1.0以前の仕様とは互換性はありません。
目次
WebSocketプロトコルに従って接続します。
wss://(APIサーバのドメイン名)?access_token=(AccessToken)
に接続してください。
Streaming APIsは、JSONオブジェクトをWebSocketのUTF-8メッセージとしてやり取りすることによって利用されます。
やり取りされるJSONオブジェクトは、必ず以下のプロパティを含んでいる必要があります。
プロパティ名 | 説明 |
---|---|
@frame | 利用するAPIに関連付いたフレーム名を指定します。 |
Streaming APIsではこのオブジェクトのことを「フレームオブジェクト」と呼んでいます。
{
"@frame": "frame name",
"paramA": "this is a parameter"
}
error.reason
はReasonIdとして定義されている文字列が返されます。
ReasonId | 説明 |
---|---|
"serverError" | サーバがリクエストの処理に失敗しました。 |
"userNotFound" | 指定されたユーザーが見つからなかったことを表します。 |
"postingNotFound" | 指定された投稿データが見つからなかったことを表します。 |
"appNotFound" | 指定された連携アプリが見つからなかったことを表します。 |
[編集中]
各エンドポイントへのリクエストをWebSocketのコネクション上から行えるようにするAPIです。
HTTPリクエストがその都度発生しないため、オーバーヘッドを小さくすることが出来ます。
{
@frame: "request",
id: number | string,
endpoint: string,
params: object?
}
{
@frame: "request",
id: number | string,
resultType: string,
result: object
}
{
@frame: "request",
id: number | string,
error: {reason: string(ReasonId), message: string}
}
id
プロパティにnumber
型の値で渡す場合、その値は整数であるべきです。小数を含む数値を渡したいときは文字列にして渡してください。
error.reason
に設定される値についてはこちらを参照してください。
{
"@frame": "request",
"id": "3",
"endpoint": "/posting/create-chat",
"params": {
"text": "コーヒー1杯で1回です"
}
}
{
"@frame": "request",
"id": "3",
"resultType": "posting",
"result": {
"createdAt": 1542525441,
"id": "5bf1120154d6cf2a485bcb6e",
"text": "コーヒー1杯で1回です",
"type": "chat",
"user": {
"createdAt": 1500702964,
"description": "コーヒーが好きです",
"followersCount": 7,
"followingsCount": 16,
"iconFileId": "5a813952bf8f203120a6b189",
"id": "5972e8f4d61aea367cbf6972",
"name": "香風智乃",
"postingsCount": {
"chat": 252
},
"screenName": "chino123"
}
}
}
リアルタイムにタイムラインや通知を受信するためのAPIです。
- "homeTimeline"
- "notification" (comming soon)
{
@frame: "eventStream.subscribe",
id: number | string,
sourceName: string
}
{
@frame: "eventStream.subscribe",
id: number | string,
result: {message: string}
}
{
@frame: "eventStream.subscribe",
id: number | string,
error: {reason: string(ReasonId), message: string}
}
id
プロパティにnumber
型の値で渡す場合、その値は整数であるべきです。小数を含む数値を渡したいときは文字列にして渡してください。
sourceNameに指定できる値についてはこちらを参照してください。
error.reason
に設定される値についてはこちらを参照してください。
{
"@frame": "eventStream.subscribe",
"id": "1",
"sourceName": "homeTimeline"
}
{
"@frame": "eventStream.subscribe",
"id": "1",
"result": {
"message": "subscribed home timeline"
}
}
{
@frame: "eventStream.unsubscribe",
id: number | string,
sourceName: string
}
{
@frame: "eventStream.unsubscribe",
id: number | string,
result: {message: string}
}
{
@frame: "eventStream.unsubscribe",
id: number | string,
error: {reason: string(ReasonId), message: string}
}
id
プロパティにnumber
型の値で渡す場合、その値は整数であるべきです。小数を含む数値を渡したいときは文字列にして渡してください。
sourceNameに指定できる値についてはこちらを参照してください。
error.reason
に設定される値についてはこちらを参照してください。
{
"@frame": "eventStream.unsubscribe",
"id": "2",
"sourceName": "homeTimeline"
}
{
"@frame": "eventStream.unsubscribe",
"id": "2",
"result": {
"message": "unsubscribed home timeline"
}
}