はてなブックマーク REST API のデータの書式
本ドキュメントに関する注意事項
本ドキュメントははてなブックマーク REST API の解説の一部です。
API が返すデータの書式
はてなブックマーク REST API は、処 理が成功した場合に JSON により結果を返します。結果は UTF-8 で符号化されています。
はてなブックマーク REST API は、処理が失敗した場合には 400, 401, 404 などの HTTP 応答を返します。この場合、JSON 形式で結果が返されるとは限りません。
API に渡すデータの書式
はてなブックマーク REST API に引数を指定する場合、HTTP の GET メソッドであれば URL の query 部分に、POST メソッドであれば entity-body に application/x-www-form-urlencoded 形式で記述してください。文字列はすべて UTF-8 により符号化しておく必要があります。
HTTP の POST メソッドを使用する場合は、application/x-www-form-urlencoded 形式のかわりに multipart/form-data 形式としても構いません。
ブックマーク
| 名前 | 意味 | データ型 |
|---|---|---|
comment | ブックマークコメント | 文字列 |
created_datetime | ブックマークした日時 | 日時 |
created_epoch | ブックマークし た日時を表す UNIX epoch time | 数値 |
user | ブックマークしたユーザーのはてな ID | 文字列 |
permalink | ブックマークを表す URL | URL |
private | 非公開でブックマークされたかどうかを表す | 真偽値 |
tags | ブックマークにつけられたタグ | 文字列の配列 |
エントリー
エントリーオブジェクトには、次の値が含まれます。
| 名前 | 意味 | データ型 |
|---|---|---|
title | エントリーのタイトル | 文字列 |
url | エントリーの URL | URL |
entry_url | エントリーページの URL | URL |
count | ブックマークの数 | 数値 |
favicon_url | Favicon の URL | URL |
smartphone_app_entry_url | スマートフォンむけにヘッダーなどを省略したコメント一覧ページの URL | URL |
ユーザー情報
| 名前 | 意味 | データ型 |
|---|---|---|
name | ユーザーのはてな ID | 文字列 |
plususer | はてなブックマークのプラスユーザーかどうか | 真偽値 |
private | ブックマーク全体を非公開に設定しているかどうか | 真偽値 |
is_oauth_twitter | Twitter を OAuth 認証しているかどうか | 真偽値 |
is_oauth_evernote | Evernote を OAuth 認証しているかどうか | 真偽値 |
is_oauth_facebook | Facebook を OAuth で認証しているかどうか | 真偽値 |
is_oauth_mixi_check | mixi を OAuth で認証しているかどうか | 真偽値 |
タグ
| 名前 | 意味 | データ型 |
|---|---|---|
count | タグがつけられたブックマークの数 | 数値 |
tag | タグを表す文字列 | 文字列 |
値のデータ型
真偽値
真偽値は、null, 数値の 0, 文字列の 0 のいずれかによ り偽を、それ以外の値により真を表します。
数値
数値は、数値または数値を文字列化したものによって表します。
日時
日時は、妥当な大域日時文字列によって表します。
はてなブックマーク REST API では、「HTTP の日時」とは RFC 2616 における rfc1123-date を意味します。
URL
URL は、絶対 URL によって表します。