Hatena::Grouphatenadeveloper

はてなハイク REST API

ja/haiku/apis/rest

はてなハイク REST API

はじめに

はてなハイク REST API を使うと、はてなハイクのエントリー、キーワード、お気に入りなどの情報を取得したり、新規に作成・投稿したりできます。

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

API の仕様は予告なく変更される可能性があります。

過剰な連続アクセス、 User-Agent を正しく指定しないアクセスなどは予告なしに制限をかける場合があります。

バージョン

本ドキュメントで「バージョン1.1」と記載した内容は、2011年2月14日よりはてなハイク正式版のドメイン (h.hatena.ne.jp, h.hatena.com) に適用されています。また、2010年12月24日よりはてなハイクベータ版のドメイン (h1beta.hatena.ne.jp, h1beta.hatena.com) に適用されています。

認証

認証なしでのアクセス

本 API の提供する読み取り機能のほとんどは、認証なしで利用できます。

OAuth

バージョン1.1の新機能

本 API は OAuth によるユーザー認証に対応しています。 OAuth 認証の詳細に関しては、はてなサービスにおける OAuth を参照してください。

読み取り機能には read_public 操作、書き込み・削除機能には write_public 操作の承認を得ている必要があります。

Basic 認証

バージョン1.1で非推奨

HTTP で定められている基本 (basic) 認証も利用できます。ユーザ名にはてなIDを、パスワードには投稿用アドレス (...@h.hatena.ne.jp のもの) を指定します。安全性考慮のため通常のはてなのパスワードではないのでご注意ください

基本 (basic) 認証の利用は非推奨となっております。

提供するフォーマット

JSON, JSONP, XML をサポートしており、それぞれ URL の末尾に .json, .json?callback=cb, .xml をつけることで指定します。詳しい説明や各 API の出力の例をご覧ください。

タイムライン API

0個以上の投稿 (エントリー) のリストをタイムラインと呼びます。次の各 API によりタイムラインを取得できます。

名前対応するページ
statuses/public_timelineはてなハイクのトップページ
statuses/keyword_timelineキーワードのエントリーページ
statuses/user_timelineユーザーのエントリーページ
statuses/friends_timelineユーザーのアンテナページ
statuses/albumはてなハイクのアルバムページ、キーワードのアルバムページ

投稿・スター API

次の各 API により投稿や投稿へのスターを取得したり、操作したりできます。

名前実行する操作
statuses/update新たに投稿する
statuses/show投稿の情報を取得する
statuses/destroy投稿を削除する
favorites/createスターを追加する
favorites/destroyスターを削除する

ユーザー・キーワード API

次の各 API によりユーザーやキーワードの情報を取得したり、操作したりできます。

名前実行する操作
friendships/showユーザー情報を取得する
keywords/showキーワード情報を取得する
keywords/hotホットキーワード情報を取得する
keywords/listキーワードを検索する
keywords/relation/create関連キーワードを追加する
keywords/relation/destroy関連キーワードを削除する

お気に入り API

次の各 API によりユーザーやキーワードのお気に入りの情報を取得したり、操作したりできます。

名前実行する操作
statuses/friendsユーザーのお気に入りユーザーのリストを取得する
statuses/followersユーザーのファンのリストを取得する
friendships/createお気に入りユーザーを追加する
friendships/destroyお気に入りからユーザーを削除する
statuses/keywordsユーザーのお気に入りキーワードのリストを取得する
keywords/createお気に入りキーワードを追加する
keywords/destroyお気に入りからキーワードを削除する

twitter API との互換性

twitter 互換 API

以下の API は twitter と一部互換性があります。ただしはてなハイク用に機能が追加、修正されています。

はてなハイク専用 API

はてなハイク専用に、以下の専用 API があります。

変更履歴

  • 2010年12月13日 Hatena Developer Center で改めて公開。
  • 2010年12月24日 はてなハイク1.1ベータ版の情報を追加。
  • 2011年2月14日 はてなハイク1.1の情報を追加。