Hatena::Grouphatenadeveloper

はてなハイクお気に入り API

ja/haiku/apis/rest/follows

はてなハイクお気に入り API

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

本ドキュメントははてなハイク REST API の解説の一部です。

お気に入り API の概要

はてなハイクお気に入り API を使うとユーザーやキーワードのお気に入りの情報を取得したり、操作したりできます。

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

page 引数

リストを取得する API では page 引数でページ番号を指定できます。最大値は 100 です。

statuses/friends

認証したユーザー、または指定したユーザーがお気に入りに追加しているユーザーのリストを返します。

URL

http://{domain}/api/statuses/friends/{url_name}.{format}?{parameters}
http://{domain}/api/statuses/friends.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{url_name}取得するユーザーのはてなIDです。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

URL に {url_name} が含まれる場合、認証は必要ありません。

URL に {url_name} が含まれない場合、 OAuth (read_public 権限) または基本認証が必要です。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, page

結果

取得に成功した場合、ユーザー配列を返します。

statuses/followers

認証したユーザー、または指定したユーザーをお気に入りに追加しているユーザー (ファン) のリストを返します。

URL

http://{domain}/api/statuses/followers/{url_name}.{format}?{parameters}
http://{domain}/api/statuses/followers.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{url_name}取得するユーザーのはてなIDです。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

URL に {url_name} が含まれる場合、認証は必要ありません。

URL に {url_name} が含まれない場合、 OAuth (read_public 権限) または基本認証が必要です。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, はてなハイク1.1の新機能 page

結果

取得に成功した場合、ユーザー配列を返します。

friendships/create

指定したユーザーを認証したユーザーのお気に入りに追加します。

URL

http://{domain}/api/friendships/create/{url_name}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{url_name}お気に入りに追加するユーザーのはてなIDです。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

OAuth (write_public 権限) または基本認証が必要です。

メソッド

HTTP POST メソッドでアクセスしてください。

引数

次の引数を指定できます: callback

結果

追加に成功した場合、追加されたユーザーオブジェクトを返します。

friendships/destroy

指定したユーザーを認証したユーザーのお気に入りから削除します。お気に入りに含まれていなければ何もしません。

URL

http://{domain}/api/friendships/destroy/{url_name}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{url_name}お気に入りから削除するユーザーのはてなIDです。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

OAuth (write_public 権限) または基本認証が必要です。

メソッド

HTTP POST メソッドでアクセスしてください。

引数

次の引数を指定できます: callback

結果

削除に成功した場合、削除されたユーザーオブジェクトを返します。

statuses/keywords

認証したユーザー、または指定したユーザーのお気に入りキーワードのリストを返します。

URL

http://{domain}/api/statuses/keywords/{url_name}.{format}?{parameters}
http://{domain}/api/statuses/keywords.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{url_name}取得するユーザーのはてなIDです。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

URL に {url_name} が含まれる場合、認証は必要ありません。

URL に {url_name} が含まれない場合、 OAuth (read_public 権限) または基本認証が必要です。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, はてなハイク1.1の新機能 page, without_related_keywords

関連キーワードの情報を使わない場合は without_related_keywords 引数を指定することをおすすめします。

結果

取得に成功した場合、キーワード配列を返します。

keywords/create

指定したキーワードを認証したユーザーのお気に入りに追加します。

URL

http://{domain}/api/keywords/create.{format}?{parameters}
http://{domain}/api/keywords/create/{url_name}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。
{keyword}非推奨 追加するキーワードの word です。かわりに word 引数を使うことをおすすめします。

認証

OAuth (write_public 権限) または基本認証が必要です。

メソッド

HTTP POST メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, はてなハイク1.1の新機能 without_related_keywords, word

関連キーワードの情報を使わない場合は without_related_keywords 引数を指定することをおすすめします。

結果

追加に成功した場合、追加されたキーワードオブジェクトを返します。

keywords/destroy

指定したキーワードを認証したユーザーのお気に入りから削除します。お気に入りに含まれていなければ何もしません。

URL

http://{domain}/api/keywords/destroy.{format}?{parameters}
http://{domain}/api/keywords/destroy/{keyword}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。
{keyword}非推奨 削除するキーワードの word です。かわりに word 引数を使うことをおすすめします。

認証

OAuth (write_public 権限) または基本認証が必要です。

メソッド

HTTP POST メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, はてなハイク1.1の新機能 without_related_keywords, word

関連キーワードの情報を使わない場合は without_related_keywords 引数を指定することをおすすめします。

結果

削除に成功した場合、削除されたキーワードオブジェクトを返します。

GET http://h.hatena.ne.jp/api/statuses/friends.xml

<users type="array">
    <user>
    <name>jkondo</name>
    <followers_count>1</followers_count>
    <id>jkondo</id>
    <profile_image_url>http://www.hatena.ne.jp/users/jk/jkondo/profile.gif</profile_image_url>
    <screen_name>jkondo</screen_name>
    <url>http://h.hatena.ne.jp/jkondo/</url>
    </user>
    ...
</users>

GET http://h.hatena.ne.jp/api/statuses/frineds.json

[
    {
        "followers_count" : 1,
        "url" : "http://h.hatena.ne.jp/jkondo/",
        "profile_image_url" : "http://www.hatena.ne.jp/users/jk/jkondo/profile.gif",
        "name" : "jkondo",
        "id" : "jkondo",
        "screen_name" : "jkondo"}
    ,
    ...
]

POST http://h.hatena.ne.jp/api/friendships/create/jkondo.xml

お気に入りに追加されます。

<user>
    <name>jkondo</name>
    <followers_count>100</followers_count>
    <id>jkondo</id>
    <profile_image_url>http://www.hatena.ne.jp/users/jk/jkondo/profile.gif</profile_image_url>
    <screen_name>jkondo</screen_name>
    <url>http://h.hatena.ne.jp/jkondo/</url>
</user>

POST http://h.hatena.ne.jp/api/friendships/create/jkondo.json

お気に入りに追加されます。

{
    "name" : "jkondo",
    "followers_count" : "100",
    "id" : "jkondo",
    "profile_image_url" : "http://www.hatena.ne.jp/users/jk/jkondo/profile.gif",
    "screen_name" : "jkondo",
    "url" : "http://h.hatena.ne.jp/jkondo/",
}

GET http://h.hatena.ne.jp/api/statuses/keywords.xml

<keywords type="array">
    <keyword>
        <entry_count>10</entry_count>
        <followers_count>100</followers_count>
        <link>http://h.hatena.ne.jp/はてなハイク</link>
        <related_keywords>RELATED_KEYWORD</related_keywords>
        <!-- related_keywords ... -->
        <title>はてなハイク</title>
    </keyword>
    <!-- keyword ... -->
</users>

GET http://h.hatena.ne.jp/api/statuses/keywords.json

[
    {
        "entry_count" : 10,
        "followers_count" : 100
        "link" : "http://h.hatena.ne.jp/はてなハイク",
        "related_keywords" : ["RELATED_KEYWORD", ... ],
        "title" : "はてなハイク",
    }
    ...
]

POST http://h.hatena.ne.jp/api/keywords/create/KEYWORD.xml

お気に入りに追加します。

<keyword>
    <status>
    <created_at>2008-08-18T00:00:00Z</created_at>
    <entry_count>13</entry_count>
    <link>http://h.hatena.ne.jp/keyword/KEYWORD</link>
    <followers_count>2</followers_count>
    <related_keywords>はてなハイク</related_keywords>
    <!-- related_keywords ... -->
    <title>KEYWORD</title>
    </status>
</keyword>

POST http://h.hatena.ne.jp/api/keywords/create/KEYWORD.json

お気に入りに追加します。

{
    "related_keywords" : [
        "はてなハイク",
        ...
    ],
    "created_at" : "2008-08-18T00:00:00Z",
    "followers_count" : "2",
    "title" : "KEYWORD",
    "link" : "http://h.hatena.ne.jp/keyword/KEYWORD",
    "entry_count" : "13"
}

変更履歴

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