api docs (ja)

内容を充実させるために加筆が求められています。

お知らせ

運用中のFrost-APIは、まもなく OAuth 2.0(Authorization Code Grant)に対応する見込みです。
現時点では古い仕様のAPIが公式アプリケーションに対してのみ提供されています。
新しい仕様のFrost-APIは連携アプリケーションを登録することによって利用が可能になる予定です。

---

目次

• REST API
• Streaming APIs
  • Request API
  • Event API

---

REST API

HTTPリクエストすることによって各種操作を行う基本的なAPIです。
AccessTokenを利用することで付与(Grant)されているスコープ範囲の操作が可能になります。必要なスコープについての詳細は各エンドポイントの項目を参照してください。

オブジェクト

User

{
    "user": {
        "createdAt": 1500702964,
        "description": "コーヒーが好きです",
        "followersCount": 3,
        "followingsCount": 5,
        "iconFileId": "5a813952bf8f203120a6b189",
        "id": "5972e8f4d61aea367cbf6972",
        "name": "香風智乃",
        "postsCount": {
            "status": 173
        },
        "screenName": "chino"
    }
}

Status Post

{
    "postStatus": {
        "createdAt": 1524890102,
        "id": "5ae3f9f630f9d22b8499f162",
        "text": "コーヒー1杯で1回です",
        "type": "status",
        "user": { "Userオブジェクトが入ります" },
        "userId": "5972e8f4d61aea367cbf6972"
    }
}

エンドポイント

---

目次

• POST /posts/post_status - 新しいstatusポストを投稿する

---

新しいStatusポストを投稿する

POST /posts/post_status

必要なスコープ

• post.write

パラメータ

パラメータ名	型	備考
text	string	必須。ポストの本文を指定します。
attachments	fileId[]	添付するメディアのIDを配列で指定します。

リクエスト例

{ "text": "コーヒー1杯で1回です" }

レスポンス

status: 200 OK

{
	"postStatus": {
		"createdAt": 1524890102,
		"id": "5ae3f9f630f9d22b8499f162",
		"text": "コーヒー1杯で1回です",
		"type": "status",
		"user": {
			"createdAt": 1500702964,
			"description": "コーヒーが好きです",
			"followersCount": 3,
			"followingsCount": 5,
			"iconFileId": "5a813952bf8f203120a6b189",
			"id": "5972e8f4d61aea367cbf6972",
			"name": "香風智乃",
			"postsCount": {
				"status": 173
			},
			"screenName": "chino"
		},
		"userId": "5972e8f4d61aea367cbf6972"
	}
}

[執筆中]

Streaming APIs

WebSocketプロトコルに従って接続します。
wss://(APIのURL)?access_token=(AccessToken)に接続してください。
Streaming APIsでは共通して、JSON形式のデータをWebSocketのUTF-8メッセージとしてリクエストします。

JSONデータに含める属性

• "type" 属性: 利用するAPIの種類を表します。
• "data" 属性: 送信するパラメータを表します。

リクエスト例

{
  "type":"rest",
  "data": {
    "endpoint":"/",
    "method":"get"
  } 
}

Request API

各エンドポイントへのリクエストをストリーミング上から行えるようにするAPIです。
HTTPリクエストがその都度発生しないため高速です。

[執筆中]

Event API

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

[執筆中]