開発者向け iddy API 仕様書

開発者向け iddy API に関する仕様書情報を掲載しています。

iddy API 仕様書

iddy API は REST API 形式によるデータ取得をサポートします。リクエストに対するレスポンスは XML 形式で行われます。下記にリクエスト仕様、及びレスポンス仕様に関する説明を掲載しておりますので、ご参考ください。

リクエスト仕様

リクエストURL ： http://iddy.jp/api/user/?

上記リクエストURLの末尾に、下記の各種パラメータを付加することで、様々なデータを柔軟に取得することが可能です。各パラメータは「&」で連結することができます。

リクエスト例 ： http://iddy.jp/api/user/?apikey=key&type=basic

apikey * 取得したAPIキーを入力します。このパラメータは必須です。
type 出力データタイプを指定します。 (デフォルト：all)
  • all：全データ
  • basic：基本情報のみ
sort データの並び順を指定します。
(デフォルト：date-regist-desc)
  • date-regist-desc：登録の新しい順
  • date-regist-asc：登録の古い順
  • accountname-asc：アカウント名昇順
  • accountname-desc:アカウント名降順
page データが複数ページに渡る場合、取得するページ番号を指定します。
(デフォルト：1)
perpage データ取得件数を指定します。
(デフォルト：10)
searchmode 検索キーワードを複数指定した際の検索モードを指定します。
(デフォルト：and)
  • and : AND検索
  • or : OR検索
accountname アカウント名で検索する場合に指定します。
gender 性別で検索する際に指定します。
(デフォルト：指定なし)
  • male : 男性
  • female : 女性
age 年齢で検索する際に指定します。
(デフォルト：指定なし)
  • n : n歳
  • n- : n歳以上
  • -n : n歳以下
  • n1-n2 : n1歳～n2歳
country 国名で検索する際に指定します。
pref 都道府県で検索する際に指定します。
hometown ホームタウンで検索する際に指定します。
personaltag パーソナルタグで検索する際に指定します。
favoritemovie 好きな映画で検索する際に指定します。
favoritefood 好きな食べ物で検索する際に指定します。
favoritemusic 好きな音楽、音楽家で検索する際に指定します。
hobby 趣味で検索する際に指定します。
リクエストの際の注意事項

リクエストの文字コードは「utf-8」のみとなります。また、リクエストパラメータに日本語等、マルチバイト文字を含む場合は、URLエンコードが必要です。

レスポンス仕様

リクエストに対するレスポンスは、XML形式（文字コードは utf-8）で行われます。XMLのフォーマットは下記の通りです。

<response> ルートタグです。属性として「status」が付加され、属性値に結果ステータスが下記の通り入ってきます。　　
  • ok ： 成功
  • fail : 失敗
<users> 属性、及び属性値として下記の項目が付加されてきます。
  • page ： ページ番号
  • pages ： 総ページ数
  • perpage ： 1ページあたりの件数
  • total ： 総件数
<user> リクエストに応じて取得したユーザー情報を返します。ユーザーの数だけ繰り返されます。子要素として下記の要素、及び内容を含みます。リクエスト時の出力データタイプが、「all」だった場合と、「basic」だった場合で出力される項目数が異なります。
  • <accountname> ： アカウント名
  • <registdate> ： 登録日時
  • <profileurl> ： プロフィールページURL
  • <imageurl> ： プロフィール画像URL
  • <name> ： 名前
  • <namekana> ： ふりがな
  • <nameroma> ： 名前(ローマ字)
以下は「all」でリクエストした時のみ
  • <birthday> ： 生年月日
  • <gender> ： 性別
  • <country> ：国
  • <pref> ： 都道府県
  • <hometown> ： ホームタウン
  • <mail> ： メールアドレス
  • <submail> ： サブメールアドレス
  • <yahoomessenger> ： Yahoo!メッセンジャID
  • <skype> ： SkypeID
  • <msnmessenger> ： MSN Messenger ID
  • <googletalk> ： Google Talk ID
  • <mixi> ： Mixi ID
  • <profile> ： プロフィール
  • <personaltag> ： パーソナルタグ（,区切り）
  • <favoritemovie> ： 好きな映画（,区切り）
  • <favoritefood> ： 好きな食べ物（,区切り）
  • <favoritemusic> ： 好きな音楽、音楽家（,区切り）
  • <hobby> ： 趣味（,区切り）
ユーザーが「非公開」に設定しているものに関しましては取得できません。よって、同じリクエストを投げても、ユーザーによって戻ってくる内容には差異があります。
<error> リクエストに対して何らかの理由で正常なレスポンスが不可能だった際に返されます。属性、及び属性値として下記が付加されます。
  • message ： エラーメッセージ

表示義務

iddy API を利用して開発したすべてのウェブサイト、アプリケーションには、以下のクレジットを表示してください。

Powered by iddy.jp

表示方法は、画像に置き換えたりしてもかまいませんが、文言とリンク先は変更しないでください。