どこどこJP

English

REST API(XML、JSONでの利用)

アクセス判定結果をXMLやJSONで取得することができます。PERLやPHPなどのサーバーサイドプログラムなどから簡単に利用する事ができます。また、パラメータにIPアドレスを付与することでIPアドレスの検索が可能です。

リクエストURL


http://api.docodoco.jp/v5/search?パラメータ名=パラメータ値…

リクエストパラメータ

パラメータ名及びパラメータ値は大文字小文字を区別します。
※パラメータの指定が無い場合は「デフォルト値」となります。

REST API リクエストパラメータ一覧表
パラメータ名 説明 デフォルト値
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のタグの順番は保証しておりません。タグの順番に依存するデータ取得方法は避けるようお願い申し上げます。
値は今アクセスされている環境の情報を元に表示しています。

基本のパラメータ

どこどこJPをご利用いただく際に、デフォルトで取得できるデータの一覧です。
オプションとして提供しているデータについては、サードパーティデータをご覧ください。

REST API 基本のパラメータ一覧表
種類 パラメータ名 説明 値、サンプル
ContinentCode コード取得
(大陸)
取得中...
CountryCode コード取得
(国)
取得中...
CountryAName 英語表記取得 取得中...
CountryJName 日本語表記取得 取得中...
都道府県 RegionCode コード取得
(地方)
取得中...
PrefCode コード取得
(都道府県)
取得中...
PrefAName ローマ字表記取得 取得中...
PrefJName 日本語表記取得 取得中...
PrefLatitude 緯度取得 取得中...
PrefLongitude 経度取得 取得中...
市区町村 CityCode コード取得
(市区町村)
取得中...
CityAName ローマ字表記取得 取得中...
CityJName 日本語表記取得 取得中...
CityLatitude 緯度取得 取得中...
CityLongitude 経度取得 取得中...
組織 BCFlag 企業フラグ取得 取得中...
OrgCode コード取得
(企業)
取得中...
OrgOfficeCode 本支店フラグ取得 取得中...
OrgIndependentCode 自営業フラグ取得 取得中...
OrgName 企業名取得 取得中...
OrgPrefCode コード取得
(都道府県)
取得中...
OrgCityCode コード取得
(市区町村)
取得中...
OrgLatitude 緯度取得 取得中...
OrgLongitude 経度取得 取得中...
OrgZipCode 郵便番号取得 取得中...
OrgAddress 住所取得 取得中...
OrgTel 電話番号取得 取得中...
OrgFax FAX番号取得 取得中...
OrgIpoType 上場区分フラグ取得 取得中...
StockTickerNumber 証券コード取得
取得中...
OrgDate 設立年月日取得 取得中...
OrgCapitalCode 資本金コード取得 取得中...
OrgEmployeesCode 従業員数コード取得 取得中...
OrgGrossCode 売上高コード取得 取得中...
OrgPresident 代表者名取得 取得中...
OrgIndustrialCategoryL 業種大分類取得 取得中...
OrgIndustrialCategoryM 業種中分類取得 取得中...
OrgIndustrialCategoryS 業種小分類取得 取得中...
OrgIndustrialCategoryT 業種細分類取得 取得中...
OrgUrl WEBサイトアドレス取得 取得中...
OrgDomainName ドメイン名取得
(組織データに基づく)
取得中...
DomainType ドメインタイプ取得
(IPデータに基づく)
取得中...
OrgEnglishName 組織 社名・屋号英語表記 取得中...
OrgEnglishAddress 組織 住所英語表記 取得中...
環境 IP IPアドレス取得 取得中...
LineCode 回線コード取得 取得中...
LineJName 回線日本語表記取得 取得中...
TimeZone タイムゾーン 取得中...
TelCode 市外局番取得
(組織データに基づく)
取得中...
DomainName ドメイン名取得
(IPに基づく)
取得中...
ProxyFlag プロキシ判定取得 取得中...
EncryptedIP IPアドレスを暗号化した文字列 取得中...
判定値(CF) PrefCF 都道府県CF値取得 取得中...
CityCF 市区町村CF値取得 取得中...
LineCF 回線CF値取得 取得中...


サードパーティデータ

以下のデータは、どこどこJPのオプションとしてご提供しています。 ご利用の際は、どこどこJP管理画面より、データの取得を有効化するお手続きを行ってください。詳細は法人番号関連データをご覧ください。

サードパーティデータのリターンパラメータは、対応するエレメント(プロパティ)の中に、子エレメントとして展開されます。レスポンスのサンプルは、どこどこJP管理画面でご確認いただけます。

JavaScript API サードパーティデータのリターンパラメータ一覧表
種類 パラメータ名 説明 値、サンプル
法人番号 HoujinBangou 法人番号 取得中...
HoujinName 商号または名称
(法人番号に基づく)
取得中...
HoujinAddress 本社所在地
(法人番号に基づく)
取得中...
HoujinLastUpdate 法人番号関連データ更新日 取得中...


結果

DEMOデータでご確認下さい。

REST API エラー

エラーが発生した場合には、以下の情報を返します。

REST API エラーメッセージ一覧表
種類 ステータス メッセージ 内容
認証 401 Unauthorized APIキーの認証に失敗

Unauthorizedの場合

<?xml version="1.0" encoding="utf-8"?><docodoco><status>401</status><message>Unauthorized</message></docodoco>

REST形式のご利用について


REST形式のご利用に際して、ご利用用途を確認させていただいております。
お手数ですが、下記お問合せ窓口までご連絡ください。

サイバーエリアリサーチ株式会社 カスタマーサポートセクション
TEL:055-981-0205 Webフォーム:https://www.docodoco.jp/contact/support.html

now loading...

Page Top