ご利用マニュアル
1.ジオクリAPI一覧
ジオクリAPIとして以下のAPIが公開されています。
・コンテンツ検索API
・コンテンツ投稿API
・位置情報履歴取得API New! 2008/01/02
・位置情報書き込みAPI New! 2008/01/02
2.API利用方法
2-1.基本仕様
各APIは指定されたURLに対して、リクエストパラメータを指定しGETまたはPOSTにてHTTPクエリを発行することで利用することができ、各APIの呼び出し結果（レスポンス）はXMLの形で取得できます。
各APIのリクエスト、レスポンス仕様の詳細は「2-3.各API仕様詳細」をご覧ください。
2-2.エラー仕様
各APIの処理にてエラーが発生した場合には、以下の形式のXMLをレスポンスとして返します。
| パラメータ名(タグ名） | 出現 回数 |
型 | 説明 | ||
| geoclip | 1 | complexType | ルートノード | ||
| error | 1 | complexType | エラー | ||
| code | 1 | integer | エラーコード（詳細は「エラーコード一覧」をご覧ください） | ||
エラーコード一覧
| エラーコード | エラーメッセージ | エラー内容 | |||
| 600 | No Contents | 指定された記事の情報が存在しない。 | |||
| 601 | Invalid Access | 不正なアクセス（認証エラー）。 | |||
| 602 | Invalid Member Number | 不正なユーザーIDパラメータ、コンテンツIDパラメータが指定された。 | |||
| 603 | Invalid Type | 不正な取得種別が指定された。 | |||
| 604 | Internal Server Error | 処理中にエラーが発生した。 | |||
サンプル
<?xml version="1.0" encoding="UTF-8"?>
<gnavi>
<error>
<code>602</code>
</error>
</gnavi>
不正アクセスの場合には上記のようなXMLデータが返ります。
2-3.各API仕様詳細
2-3-1.コンテンツ検索API [GET]
http://api.geoclip.jp/api/feed.php?各種パラメタ
リクエストパラメータ
| パラメーター名 | 必須 | 型 | 説明 | 備考 |
| keyid | ○ | string | アクセスキー | ジオクリより提供したアクセスキー |
| contents_id | integer | コンテンツID | コンテンツIDが分かる場合は、コンテンツIDを一意に指定することが可能。 | |
| search_word | string | 検索ワード | UTF-8でURLエンコードすること | |
| category_cd | string | カテゴリコード | 「01」～「09」のカテゴリコード | |
| member_id | integer | ユーザーID | 特定のユーザーの記事を検索する場合に指定。 | |
| create_date_from | datetime | 投稿時刻FROM | 検索対象投稿時刻FROM（古い） 'YYYY-MM-DD HH:MM:SS'のURLエンコード | |
| create_date_to | datetime | 投稿時刻TO | 検索対象投稿時刻TO（新しい） 'YYYY-MM-DD HH:MM:SS'のURLエンコード | |
| latitude | number | 緯度 | WGS84、度形式（小数点以下百分率）、南緯は負の数 ※緯度経度はセットで指定すること | |
| longitude | number | 経度 | WGS84、度形式（小数点以下百分率）、西経は負の数 ※緯度経度はセットで指定すること | |
| range | integer | 範囲 | 緯度/経度からの検索範囲(半径)単位＝m（デフォルト:1000） | |
| sort | integer | ソート順 | 0:近い順、1:投稿日時が若い順 | |
| offset | integer | 検索開始位置 | 検索開始レコード位置（デフォルト:1) | |
| hit_per_page | integer | ヒット件数 | 一度のリクエストで帰るレスポンスデータ(デフォルト:10） | |
| offset_page | integer | 検索開始ページ | 検索開始ページ位置(デフォルト:1) |
レスポンス
| パラメータ名 | 出現 回数 |
型 | 説明 | ||
| Response | 1 | complexType | レスポンスルート | ||
| total_hit_count | 1 | integer | 該当件数 | ||
| hit_per_page | 1 | integer | 表示件数 | ||
| page_offset | 1 | integer | 表示ページ | ||
| rest | 複数回 | complexType | コンテンツ情報 | ||
| contents_id | 1 | integer | コンテンツＩＤ | ||
| title | 1 | string | タイトル | ||
| subject | 1 | string | 本文 | ||
| tag | 1 | string | タグ（スペース区切り） | ||
| member_id | 1 | integer | ユーザーのＩＤ | ||
| auther_name | 1 | string | 記事の投稿者名 | ||
| image_url | 1 | string | イメージのURL | ||
| latitude | 1 | number | 緯度 WGS84、度形式（小数点以下百分率） | ||
| longitude | 1 | number | 経度 WGS84、度形式（小数点以下百分率） | ||
| create_date | 1 | datetime | YYYY-MM-DD HH:MM:SS | ||
| good_count | 1 | integer | GOODカウント数 | ||
| access_count | 1 | integer | アクセスカウント数 | ||
サンプルクエリ
http://api.geoclip.jp/api/feed.html
http://api.geoclip.jp/api/feed.php?keyid= (発行されたアクセスキー）&contents_id=90
上記のクエリを送信することにより以下のようなXMLデータを取得できます。
<?xml version="1.0" encoding="UTF-8"?>
<response>
<total_hit_count>1</total_hit_count>
<hit_per_page>10</hit_per_page>
<page_offset>1</page_offset>
<rest order="0">
<contents_id>90</contents_id>
<title>六本木ト ラットリアジリオーラのランチステーキ</title>
<subject>ｋｔｋｒ！ウマ〜〜</subject>
<tag></tag>
<member_id>1</member_id>
<auther_name>つよぽん</auther_name>
<image_url>http://m.geoclip.jp/upload/1/90.jpg</image_url>
<latitude>35.663219</latitude>
<longitude>139.732375</longitude>
<create_date>2007-05-11 21:01:13</create_date>
<good_count>9</good_count>
<access_count>209</access_count>
</rest>
</response>
2-3-2.コンテンツ投稿API [POST]
http://api.geoclip.jp/api/post.php
リクエストパラメータ
| パラメーター名 | 必須 | 型 | 説明 | 備考 |
| keyid | ○ | string | アクセスキー | ジオクリより提供したアクセスキー |
| title | ○ | string | 題名 | UTF-8 |
| contents_type | ○ | number | コンテンツタイプ | 1=通常の投稿、それ以外未定 |
| body | string | 記事本文 | UTF-8 | |
| tag | string | タグ情報 | UTF-8、複数のタグを記述する場合、各タグの区切りは半角スペース | |
| category_cd | ○ | string | カテゴリコード | 「01」～「09」のカテゴリコード |
| latitude | ○ | number | 緯度 | WGS84、度形式（小数点以下百分率）、南緯は負の数 |
| longitude | ○ | number | 経度 | WGS84、度形式（小数点以下百分率）、西経は負の数 |
| image | binary | 画像 | Jpeg形式の画像ファイル |
レスポンス
| パラメータ名 | 出現 回数 |
型 | 説明 | ||
| Response | 1 | complexType | レスポンスルート | ||
| total_hit_count | 1 | integer | 該当件数 | ||
| hit_per_page | 1 | integer | 表示件数 | ||
| page_offset | 1 | integer | 表示ページ | ||
| rest | 1 | complexType | コンテンツ情報 | ||
| contents_id | 1 | integer | コンテンツＩＤ | ||
| title | 1 | string | タイトル | ||
| subject | 1 | string | 本文 | ||
| tag | 1 | string | タグ（スペース区切り） | ||
| member_id | 1 | integer | ユーザーのＩＤ | ||
| auther_name | 1 | string | 記事の投稿者名 | ||
| image_url | 1 | string | イメージのURL | ||
| latitude | 1 | number | 緯度 WGS84、度形式（小数点以下百分率） | ||
| longitude | 1 | number | 経度 WGS84、度形式（小数点以下百分率） | ||
| create_date | 1 | datetime | YYYY-MM-DD HH:MM:SS | ||
| good_count | 1 | integer | GOODカウント数 | ||
| access_count | 1 | integer | アクセスカウント数 | ||
サンプルクエリ
http://api.geoclip.jp/api/post.html
上記のURLに下記のHTMLフォームから生成されるのと、同等のクエリをPOSTすることにより、コンテンツを投稿することが出来、結果を以下のようなXMLデータとして取得できます。
<?xml version="1.0" encoding="UTF-8"?>
<response>
<total_hit_count>1</total_hit_count>
<hit_per_page>10</hit_per_page>
<page_offset>1</page_offset>
<rest order="0">
<contents_id>90</contents_id>
<title>六本木ト ラットリアジリオーラのランチステーキ</title>
<subject>ｋｔｋｒ！ウマ〜〜</subject>
<tag></tag>
<member_id>1</member_id>
<auther_name>つよぽん</auther_name>
<image_url>http://m.geoclip.jp/upload/1/90.jpg</image_url>
<latitude>35.663219</latitude>
<longitude>139.732375</longitude>
<create_date>2007-05-11 21:01:13</create_date>
<good_count>9</good_count>
<access_count>209</access_count>
</rest>
</response>
2-3-3.位置情報履歴取得API [GET]
http://api.geoclip.jp/api/feed_trace.php?各種パラメタ
リクエストパラメータ
| パラメーター名 | 必須 | 型 | 説明 | 備考 |
| keyid | ○ | string | アクセスキー | ジオクリより提供したアクセスキー |
| create_date_from | datetime | 投稿時刻FROM | 検索対象投稿時刻FROM（古い） 'YYYY-MM-DD HH:MM:SS'のURLエンコード | |
| create_date_to | datetime | 投稿時刻TO | 検索対象投稿時刻TO（新しい） 'YYYY-MM-DD HH:MM:SS'のURLエンコード | |
| hit_per_page | integer | ヒット件数 | 一度のリクエストで帰るレスポンスデータ(デフォルト:100） |
レスポンス
| パラメータ名 | 出現 回数 |
型 | 説明 | ||
| Response | 1 | complexType | レスポンスルート | ||
| total_hit_count | 1 | integer | 該当件数 | ||
| hit_per_page | 1 | integer | 表示件数 | ||
| page_offset | 1 | integer | 表示ページ | ||
| rest | 複数回 | complexType | コンテンツ情報 | ||
| location_id | 1 | integer | ロケーションＩＤ | ||
| latitude | 1 | number | 緯度 WGS84、度形式（小数点以下百分率） | ||
| longitude | 1 | number | 経度 WGS84、度形式（小数点以下百分率） | ||
| altitude | 1 | number | 高度 メートルm (参考値)※既存投稿のコンテンツには有りません。 | ||
| log_date | 1 | datetime | YYYY-MM-DD HH:MM:SS 位置情報取得日時 | ||
| create_date | 1 | datetime | YYYY-MM-DD HH:MM:SS ジオクリ格納日時 | ||
サンプルクエリ
http://api.geoclip.jp/api/feed_trace.html テスト用ページ
http://api.geoclip.jp/api/feed.php?keyid= (発行されたアクセスキー）&hit_per_page=1
上記のクエリを送信することにより以下のようなXMLデータを取得できます。
<?xml version="1.0" encoding="UTF-8"?>
<response>
<total_hit_count>193</total_hit_count>
<hit_per_page>1</hit_per_page>
<page_offset/>
<rest order="0">
<location_id>2503</location_id>
<latitude>35.727273</latitude>
<longitude>139.716643</longitude>
<altitude/>
<log_date>2008-01-01 01:23:43</log_date>
<create_date>2008-01-01 01:23:43</create_date>
</rest>
</response>
2-3-4.位置情報書き込みAPI [POST]
http://api.geoclip.jp/api/post_trace.php
リクエストパラメータ
| パラメーター名 | 必須 | 型 | 説明 | 備考 |
| keyid | ○ | string | アクセスキー | ジオクリより提供したアクセスキー |
| contents_type | ○ | number | コンテンツタイプ | 2を指定して下さい。それ以外未定 |
| latitude | ○ | number | 緯度 | WGS84、度形式（小数点以下百分率）、南緯は負の数 |
| longitude | ○ | number | 経度 | WGS84、度形式（小数点以下百分率）、西経は負の数 |
| altitude | number | 高度 | 1000mまで。 | |
| log_date | datetime | 位置取得日時 | YYYY-MM-DD HH:MM:SS 未指定の場合は投入時刻 |
レスポンス
| パラメータ名 | 出現 回数 |
型 | 説明 | ||
| Response | 1 | complexType | レスポンスルート | ||
| total_hit_count | 1 | integer | 該当件数 | ||
| hit_per_page | 1 | integer | 表示件数 | ||
| page_offset | 1 | integer | 表示ページ | ||
| rest | 1 | complexType | コンテンツ情報 | ||
| location_id | 1 | integer | ロケーションＩＤ | ||
| latitude | 1 | number | 緯度 WGS84、度形式（小数点以下百分率） | ||
| longitude | 1 | number | 経度 WGS84、度形式（小数点以下百分率） | ||
| altitude | 1 | number | 高度 単位[m] 未設定の場合は0m | ||
| log_date | 1 | datetime | 緯度経度取得日時'YYYY-MM-DD HH:MM:SS | ||
| create_date | 1 | datetime | ジオクリ格納日時'YYYY-MM-DD HH:MM:SS | ||
サンプルクエリ
http://api.geoclip.jp/api/post_trace.html
上記のURLのHTMLフォームから生成されるのと、同等のクエリをPOSTすることにより、コンテンツを投稿することが出来、結果を以下のようなXMLデータとして取得できます。
<?xml version="1.0" encoding="UTF-8"?>
<response>
<total_hit_count>1</total_hit_count>
<hit_per_page>1</hit_per_page>
<page_offset>1</page_offset>
<rest order="0">
<location_id>2624</location_id>
<latitude>35.658632</latitude>
<longitude>139.745411</longitude>
<altitude>100.000000</altitude>
<log_date>2008-01-02 00:00:00</log_date>
<create_date>2008-01-02 20:59:02</create_date>
</rest>
</response>
