Hatena::Grouphatenadeveloper

はてなブックマーク ブックマーク API

ja/bookmark/apis/rest/bookmark

はてなブックマーク ブックマーク API

はてなブックマーク ブックマーク API

本ドキュメントに関する注意事項

本ドキュメントははてなブックマーク REST API の解説の一部です。

ブックマーク API の概要

名前 実行する操作
GET /{version}/my/bookmark ブックマーク情報を取得する
POST /{version}/my/bookmark ブックマークを追加または更新する
DELETE /{version}/my/bookmark ブックマークを削除する

GET /{version}/my/bookmark

概要

認証したユーザーのブックマーク情報を取得します。

URL
http://api.b.hatena.ne.jp/{version}/my/bookmark
認証

OAuth 認証 (read_public または read_private) が必要です。

HTTP メソッド

HTTP GET でアクセスしてください。

引数

取得したいブックマークの URLurl クエリーパラメーターに指定します。

結果

取得に成功した場合、ブックマークオブジェクトを返します。

ブックマークが存在しない場合、ステータスコード 404 を返します。

リクエストが不正である場合、ステータスコード 400 を返します。

POST /{version}/my/bookmark

概要

認証したユーザーのブックマークを追加・更新します。

既にブックマーク済みのページであれば更新、そうでなければ新たに追加します。

URL
http://api.b.hatena.ne.jp/{version}/my/bookmark
認証

OAuth 認証 (write_public または write_private) が必要です。

HTTP メソッド

HTTP POST でアクセスしてください。

引数

ブックマークしたいページの URLurl に指定します。

任意でブックマークコメントを comment に指定することができます。

任意でブックマークにタグをつけることができます。tags クエリーパラメーターを最大10個まで指定することができます。

ブックマークした際に各種外部サービスに共有することができます。それぞれのサービスについて OAuth 認証したうえで post_twitter, post_facebook, post_mixi_check, post_evernote クエリーパラメーターに真値を渡すと共有できます。

また、認証したユーザーがはてなブックマークプラスに申し込んでいる場合は send_mail クエリーパラメーターに真値を渡すとブックマークしたページを設定したメールアドレスに送信することができます。

ブックマークを非公開にする場合は private クエリーパラメーターに真値を渡します。

結果

追加または更新に成功した場合、ブックマークオブジェクトを返します。

リクエストが不正である場合、ステータスコード 400 を返します。

DELETE /{version}/my/bookmark

概要

認証したユーザーのブックマークを削除します。

URL
http://api.b.hatena.ne.jp/{version}/my/bookmark
認証

OAuth 認証 (write_public または write_private) が必要です。

HTTP メソッド

HTTP DELETE でアクセスしてください。

引数

削除したいブックマークの URLurl クエリーパラメーターに指定します。

結果

削除に成功した場合、ステータスコード 204 を返します。

ブックマークが存在しない場合、ステータスコード 404 を返します。

リクエストが不正である場合、ステータスコード 400 を返します。