本ドキュメントははてなハイク REST API の解説の一部です。
はてなハイクユーザー・キーワード API を使うとユーザーやキーワードの情報を取得したり、操作したりできます。
名前 | 実行する操作 |
---|---|
friendships/show | ユーザー情報を取得する |
keywords/show | キーワード情報を取得する |
keywords/hot | ホットキーワード情報を取得する |
keywords/list | キーワードを検索する |
keywords/relation/create | 関連キーワードを追加する |
keywords/relation/destroy | 関連キーワードを削除する |
word
引数キーワードの情報を取得・設定する際には、 URL に {keyword} を含るか、または引数として word
を含める必要があります。どちらの場合も、キーワードの word
を指定してください。 URL に {keyword} を含める方法では正常に結果を取得できないキーワードがあるため、 word
引数を指定する方法を使うことをおすすめします。
friendships/show
指定したユーザーの情報を返します。
http://{domain}/api/friendships/show/{url_name}.{format}?{parameters}
{domain} | はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。 |
---|---|
{format} | 結果の書式です。 json または xml を指定できます。 |
{url_name} | 取得するユーザーのはてなIDです。 |
{parameters} | name1=value1&name2=value2&... の形式で引数を指定できます。 |
認証は必要ありません。
HTTP GET
メソッドでアクセスしてください。
次の引数を指定できます: callback
取得に成功した場合、ユーザーオブジェクトを返します。
keywords/show
指定したキーワードの情報を返します。
http://{domain}/api/keywords/show.{format}?{parameters} http://{domain}/api/keywords/show/{keyword}.{format}?{parameters} (非推奨)
{domain} | はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。 |
---|---|
{format} | 結果の書式です。 json または xml を指定できます。 |
{parameters} | name1=value1&name2=value2&... の形式で引数を指定できます。 |
{keyword} | 非推奨 情報を取得するキーワードの word です。かわりに word を使うことをおすすめします。 |
認証は必要ありません。
HTTP GET
メソッドでアクセスしてください。
次の引数を指定できます: callback
, はてなハイク1.1の新機能 without_related_keywords
, word
URL に {keyword} を含めない場合は、引数として word
を指定しなければなりません。
関連キーワードの情報を使わない場合は without_related_keywords
引数を指定することをおすすめします。
取得に成功した場合、キーワードオブジェクトを返します。
keywords/list
http://h.hatena.ne.jp/keywords や http://h.hatena.com/keywords に表示されるキーワードのリストを返します。単語を指定してキーワードを検索することもできます。
http://{domain}/api/keywords/list.{format}?{parameters}
{domain} | はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、h.hatena.com で全世界版の情報を取得できます。 |
---|---|
{format} | 結果の書式です。 json または xml を指定できます。 |
{parameters} | name1=value1&name2=value2&... の形式で引数を指定できます。 |
認証は必要ありません。
HTTP GET
メソッドでアクセスしてください。
次の引数を指定できます: callback
, page
, はてなハイク1.1の新機能 without_related_keywords
, word
word
引数を指定すると、検索語として使用します。この引数を省略すると、はてなハイクのトップページに表示されるキーワードのリストを返します。
page
引数でページ番号を指定できます。最大値は 100 です。
関連キーワードの情報を使わない場合は without_related_keywords
引数を指定することをおすすめします。
keywords/hot
http://h.hatena.ne.jp/hotkeywords や http://h.hatena.com/hotkeywords に表示されるホットキーワードのリストを返します。
http://{domain}/api/keywords/hot.{format}?{parameters}
{domain} | はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、h.hatena.com で全世界版の情報を取得できます。 |
---|---|
{format} | 結果の書式です。 json または xml を指定できます。 |
{parameters} | name1=value1&name2=value2&... の形式で引数を指定できます。 |
認証は必要ありません。
HTTP GET
メソッドでアクセスしてください。
次の引数を指定できます: callback
, はてなハイク1.1の新機能 without_related_keywords
関連キーワードの情報を使わない場合は without_related_keywords
引数を指定することをおすすめします。
keywords/relation/create
指定した2つのキーワードを関連キーワードとします。
http://{domain}/api/keywords/relation/create.{format}?{parameters}
{domain} | はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。 |
---|---|
{format} | 結果の書式です。 json または xml を指定できます。 |
{parameters} | name1=value1&name2=value2&... の形式で引数を指定できます。 |
OAuth (write_public
権限) または基本認証が必要です。
HTTP POST
メソッドでアクセスしてください。
次の引数を指定できます: callback
, word1
, word2
, はてなハイク1.1の新機能 without_related_keywords
関連キーワードに設定するキーワードの word
を word1
と word2
に指定してください。どちらの引数も必須です。
結果中の関連キーワードの情報を使わない場合は without_related_keywords
引数を指定することをおすすめします。
関連キーワードの設定に成功した場合、 word1
で指定された キーワードオブジェクトを返します。
keywords/relation/destroy
関連キーワードを解除します。関連キーワードの設定を削除できるのは認証したユーザーが設定したものか、またはいずれかが認証したユーザーのキーワードである場合に限られます。
http://{domain}/api/keywords/relation/destroy.{format}?{parameters}
{domain} | はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。 |
---|---|
{format} | 結果の書式です。 json または xml を指定できます。 |
{parameters} | name1=value1&name2=value2&... の形式で引数を指定できます。 |
OAuth (write_public
権限) または基本認証が必要です。
HTTP POST
メソッドでアクセスしてください。
次の引数を指定できます: callback
, word1
, word2
, はてなハイク1.1の新機能 without_related_keywords
関連キーワード設定を解除するキーワードの word
を word1
と word2
に指定してください。どちらの引数も必須です。
結果中の関連キーワードの情報を使わない場合は without_related_keywords
引数を指定することをおすすめします。
関連キーワードの解除に成功した場合、 word1
で指定された キーワードオブジェクトを返します。
<user> <name>jkondo</name> <followers_count>3</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>
{ "followers_count" : 3, "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" }