[トップページ]

Geohist API について

Geohist では REST のインターフェースを準備し、ユーザの書いたメッセージなどを取得できるようにしています。

user_messages

user_messages はユーザの書いたメッセージを取得したり書き込むためのインターフェースです。

find_by_username

ユーザ名を指定して、そのユーザまたはそのユーザが友達登録している人のメッセージを表示します。

http://geohist.net/user_messages/find_by_username/[username].xml?with_follow=[true|false]

[username] のところに取得したいユーザ名を指定してください。

設定できる引数は下記のようになります。

with_follow
友達登録しているユーザのメッセージも一緒に表示するかどうか選択します。
day
メッセージを表示したい日を設定します。 日付の書式は Ruby の Time.parse の書式に会わせてください。
starttime, endtime
メッセージ一覧で表示したい時間の範囲を Unix epoch time で starttime, endtime に指定してください。

以下にAPIの利用例のURLを書きます。

普通に表示
http://geohist.net/user_messages/find_by_username/masaruyokoi.xml
友達登録している人も一緒に表示
http://geohist.net/user_messages/find_by_username/masaruyokoi.xml?with_follow=true
表示件数を指定して表示
http://geohist.net/user_messages/find_by_username/masaruyokoi.xml?num=20
表示件数とページ番号を指定して表示
http://geohist.net/user_messages/find_by_username/masaruyokoi.xml?num=20&page=2
日付を指定して表示
http://geohist.net/user_messages/find_by_username/masaruyokoi.xml?day=2008-05-23
starttime, endtime を指定して表示
http://geohist.net/user_messages/find_by_username/masaruyokoi.xml?starttime=1211468400&endtime=1211554799

返されるメッセージには、下記のようなXMLになります。

 <user_messages_response>
   <requests> <!-- リクエストの内容 -->
    <num>10</num> <!-- 出力するメッセージの数 -->
    <page>10</page> <!-- 出力するメッセージのページ番号 -->
    <with_follow>10</with_follow> <!-- 友達のメッセージも表示するかどうか -->
   </requests>
   <status> <!-- レスポンスの状態 -->
     <has_next_page>true</has_next_page>  <!-- 次のページがあるかどうか -->
   </status>
   <messages> <!-- メッセージのリスト -->
     <message> <!-- メッセージ -->
       <message>ほげほげ</message> <!-- メッセージ本文 -->
       <location_lat>35.0000000</location_lat> <!-- 北緯 -->
       <location_lon>135.0000000</location_lon> <!-- 東経 -->
       <created_at>2008-05-23T13:02:26+09:00</created_at> <!-- 作成日時 -->
       <updated_at>2008-05-23T13:02:26+09:00</updated_at> <!-- 更新日時 -->
       <id>260</id> <!-- メッセージのシリアル番号 -->
     </message>
   </messages>
 </user_messages_response>

create_message

メッセージを書き込むためのインターフェースです。

下記のパラメータを GET メソッドで送信してください。

http://geohist.net/user_messages/create_message/[username].xml?[params]
sha1pass
ユーザの暗号化済みパスワード。 password または sha1pass を指定してください。
password
ユーザのパスワード。 password または sha1pass を指定してください。
message
メッセージ本文。 UTF-8でエンコードしてください。
lat
北緯。 Float の形式で指定してください。
lon
東経。 Float の形式で指定してください。

users インターフェース

users インターフェースでは、おもにユーザ認証を行うためのインターフェースです。