REST API(XML、JSONでの利用)
アクセス判定結果をXMLやJSONで取得することができます。PERLやPHPなどのサーバーサイドプログラムなどから簡単に利用する事ができます。また、パラメータにIPアドレスを付与することでIPアドレスの検索が可能です。
リクエストURL
http://api.docodoco.jp/v4/search?パラメータ名=パラメータ値…
リクエストパラメータ
パラメータ名及びパラメータ値は大文字小文字を区別します。
※パラメータの指定が無い場合は「デフォルト値」となります。
| パラメータ名 | 説明 | 値 | デフォルト値 |
|---|---|---|---|
| key1 | APIキー1 | 英数字 | ※必須 |
| key2 | APIキー2 | 英数字 | ※必須 |
| format | レスポンス形式の指定 | xml、json | xml |
| charset | レスポンス時の文字コードの指定 | jis、sjis、eucjp、utf8 | utf8 |
| ipadr | 判定したいIPアドレスの指定 | 0.0.0.0~255.255.255.255 | アクセス元IPアドレス |
リターンパラメータ
注意:XMLのタグの順番は保証しておりません。タグの順番に依存するデータ取得方法は避けるようお願い申し上げます。
値は今アクセスされている環境の情報を元に表示しています。
※色つきのセルは、どこどこJPv4版で追加されたパラメーターです。
| パラメータ名 | 説明 | 値、サンプル |
|---|---|---|
| IP | IPアドレス | 取得中... |
| ContinentCode | 大陸 コード | 取得中... |
| CountryCode | 国 コード | 取得中... |
| CountryAName | 国 英語表記 | 取得中... |
| CountryJName | 国 日本語表記 | 取得中... |
| PrefCode | 都道府県 コード | 取得中... |
| RegionCode | 地方 コード | 取得中... |
| PrefAName | 都道府県 ローマ字表記 | 取得中... |
| PrefJName | 都道府県 日本語表記 | 取得中... |
| PrefLatitude | 都道府県 緯度 | 取得中... |
| PrefLongitude | 都道府県 経度 | 取得中... |
| PrefCF | 都道府県 判定値 | 取得中... |
| CityCode | 市区町村 コード | 取得中... |
| CityAName | 市区町村 ローマ字表記 | 取得中... |
| CityJName | 市区町村 日本語表記 | 取得中... |
| CityLatitude | 市区町村 緯度 | 取得中... |
| CityLongitude | 市区町村 経度 | 取得中... |
| CityCF | 市区町村 判定値 | 取得中... |
| BCFlag | 組織 企業フラグ | 取得中... |
| OrgCode | 組織 コード | 取得中... |
| OrgOfficeCode | 組織 本支店フラグ | 取得中... |
| OrgIndependentCode | 組織 自営業フラグ | 取得中... |
| OrgName | 企業名 | 取得中... |
| OrgPrefCode | 組織 都道府県コード | 取得中... |
| OrgCityCode | 組織 市区町村コード | 取得中... |
| OrgZipCode | 組織 郵便番号 | 取得中... |
| OrgAddress | 組織 住所 | 取得中... |
| OrgTel | 組織 電話番号 | 取得中... |
| OrgFax | 組織 FAX番号 | 取得中... |
| OrgIpoType | 組織 上場区分フラグ | 取得中... |
| OrgDate | 組織 設立年月日 | 取得中... |
| OrgCapitalCode | 組織 資本金コード | 取得中... |
| OrgEmployeesCode | 組織 従業員数コード | 取得中... |
| OrgGrossCode | 組織 売上高コード | 取得中... |
| OrgPresident | 組織 代表者名 | 取得中... |
| OrgIndustrialCategoryL | 組織 業種大分類 | 取得中... |
| OrgIndustrialCategoryM | 組織 業種中分類 | 取得中... |
| OrgIndustrialCategoryS | 組織 業種小分類 | 取得中... |
| OrgIndustrialCategoryT | 組織 業種細分類 | 取得中... |
| OrgDomainName | 組織 ドメイン名(組織データに基づく) | 取得中... |
| OrgDomainType | 組織 ドメイン種別(組織データに基づく) | 取得中... |
| OrgUrl | 組織 WEBサイトアドレス | 取得中... |
| OrgLatitude | 組織 緯度 | 取得中... |
| OrgLongitude | 組織 経度 | 取得中... |
| LineCode | 回線 コード | 取得中... |
| LineJName | 回線 日本語表記 | 取得中... |
| LineCF | 回線 判定値 | 取得中... |
| TimeZone | タイムゾーン | 取得中... |
| ProxyFlag | Proxyフラグ | 取得中... |
| TelCode | 市外局番(組織データに基づく) | 取得中... |
| StockTickerNumber | 証券コード | 取得中... |
| DomainName | ドメイン名(IPに基づく) | 取得中... |
| DomainType | ドメイン種別(IPに基づく) | 取得中... |
結果
DEMOデータでご確認下さい。
REST API エラー
エラーが発生した場合には、以下の情報を返します。
| 種類 | ステータス | メッセージ | 内容 |
|---|---|---|---|
| 認証 | 401 | Unauthorized | APIキーの認証に失敗 |
Unauthorizedの場合
<?xml version="1.0" encoding="utf-8"?><docodoco><status>401</status><message>Unauthorized</message></docodoco>
日本品質による最高レベルのIPアドレスデータベースを搭載。全世界約43億のIPv4アドレスに対応。