Hatena::Grouphatenadeveloper

はてなハイク投稿・スター API

ja/haiku/apis/rest/entries

はてなハイク投稿・スター API

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

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

投稿・スター API の概要

はてなハイク投稿・スター API を使うと投稿や投稿へのスターを取得したり、操作したりできます。

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

statuses/update

新たにはてなハイクに投稿します。投稿者は認証したユーザーとなります。

URL

http://{domain}/api/statuses/update.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、 h.hatena.com で全世界版に投稿できます。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

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

メソッド

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

引数

次の引数を指定できます: callback, file, keyword, in_reply_to_status_id, status, source, はてなハイク1.1の新機能 body_formats

投稿先のキーワードを keyword 引数に指定してください。キーワードは対象のキーワードの word となる値を指定できます。キーワードが存在しない場合には、投稿時に自動的に作成されます。

投稿の本文は status 引数に指定してください。 status 引数にははてなハイクの Web サイトと同様にはてな記法を使うことができます。

keyword 引数を省略した場合、 status 引数に = が含まれていると、その直前までをキーワード名とみなします。この場合、キーワード名と = は投稿本文には含まれません。keyword 引数は省略しないことをおすすめします。

キーワードが省略されている場合には、ユーザーキーワード (id: の後にユーザーのはてなIDを続けたもの) が指定されたとみなします。

file 引数に画像ファイルを指定すると、画像をはてなフォトライフに投稿し、その画像を本文の最後に含めます。 file 引数を指定するときは multipart/form-data を使う必要があります。はてなハイク1.1の新機能 file 引数は4つまで指定できます。

status または file の一方または両方の引数を必ず指定しなければなりません。

in_reply_to_status_id 引数に投稿の ID を指定すると、その投稿への返信となります。

廃止 status 引数の先頭に @{id} と指定することで、 {id} さんの最後の投稿への返信になります。 in_reply_to_status_id 引数が指定されていると無視されます。バージョン1.1以降ではこの機能は削除されています。

source 引数を指定すると、投稿元のクライアント名として投稿の「from」欄に表示されます。「from」欄は同名のキーワードへのリンクとなります。キーワードがなければ新たに作られます。このクライアント名は file 引数が指定されている場合にはてなフォトライフへの投稿のクライアント名としても使われます。省略すると「API」となります。

結果

投稿に成功した場合、新しい投稿の投稿オブジェクトを返します。

statuses/show

http://h.hatena.ne.jp/{username}/{eid} に対応する、指定した投稿の情報を返します。

URL

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

認証

認証は必要ありません。

メソッド

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

引数

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

結果

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

statuses/destroy

指定した投稿を削除します。投稿を削除できるのは、投稿者本人か、ユーザーキーワードの場合はそのユーザーです。

URL

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

認証

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

メソッド

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

引数

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

author_url_name 引数には削除する投稿の投稿者のはてなIDを指定してください。この引数は省略できますが、できるだけ指定することをおすすめします。

結果

投稿に成功した場合、削除した投稿の投稿オブジェクトを返します。

favorites/create

指定した投稿にスターを一つ追加します。スターをつけたユーザーは認証したユーザーとなります。

URL

http://{domain}/api/favorites/create/{eid}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{format}結果の書式です。 json または xml を指定できます。
{eid}スターをつける投稿を表す ID です。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

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

メソッド

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

引数

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

結果

スターの追加に成功した場合、追加先の投稿の投稿オブジェクトを返します。

favorites/destroy

指定した投稿のスターを一つ減らします。スターを減らすユーザーは認証したユーザーとなります。

URL

http://{domain}/api/favorites/destroy/{eid}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp または h.hatena.com のどちらでも構いません。
{format}結果の書式です。 json または xml を指定できます。
{eid}スターを減らす投稿を表す ID です。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

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

メソッド

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

引数

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

結果

スターを減らすのに成功した場合、その投稿の投稿オブジェクトを返します。

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

<status>
    <id>12345678901234</id>
    <created_at>2008-08-19T00:00:00Z</created_at>
    <favorited>0</favorited>
    <in_reply_to_status_id/>
    <in_reply_to_user_id/>
    <keyword>key</keyword>
    <link>http://h.hatena.ne.jp/jkondo/12345678901234</link>
    <source>web</source>
    <text>key=text</text>
    <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>
</status>

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

{
    "source" : "web",
    "keyword" : "key",
    "favorited" : 0,
    "created_at" : "2008-08-19T00:00:00Z",
    "text" : "key=text",
    "link" : "http://h.hatena.ne.jp/jkondo/12345678901234",
    "in_reply_to_user_id" : 0,
    "user" : {
        "followers_count" : 1,
        "profile_image_url" : "http://www.hatena.ne.jp/users/jk/jkondo/profile.gif",
        "url" : "http://h.hatena.ne.jp/jkondo/",
        "name" : "jkondo",
        "id" : "jkondo",
        "screen_name" : "jkondo"
    },
    "id" : "12345678901234",
    "in_reply_to_status_id" : 0
}

POST http://h.hatena.ne.jp/api/favorites/create/12345678901234.xml

投稿にスターが1つ追加されます。

<status>
    <id>12345678901234</id>
    <created_at>2008-08-18T00:00:00Z</created_at>
    <favorited>1</favorited>
    <in_reply_to_status_id>98765432109876</in_reply_to_status_id>
    <in_reply_to_user_id>jkondo</in_reply_to_user_id>
    <keyword>KEYWORD</keyword>
    <link>http://h.hatena.ne.jp/jkondo/12345678901234</link>
    <source>web</source>
    <text>TEXT</text>
    <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>
</status>

POST http://h.hatena.ne.jp/api/favorites/create/12345678901234.json

投稿にスターが1つ追加されます。

{
    "source" : "web",
    "link" : "http://h.hatena.ne.jp/jkondo/12345678901234",
    "keyword" : "KEYWORD",
    "favorited" : 1,
    "created_at" : "2008-08-18T00:00:00Z",
    "text" : "TEXT",
    "in_reply_to_user_id" : "jkondo",
    "user" : {
        "followers_count" : 1,
        "profile_image_url" : "http://www.hatena.ne.jp/users/jk/jkondo/profile.gif",
        "url" : "http://h.hatena.ne.jp/jkondo/",
        "name" : "jkondo",
        "id" : "jkondo",
        "screen_name" : "jkondo"
    },
    "id" : "12345678901234",
    "in_reply_to_status_id" : "98765432109876"
}

変更履歴

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