REST API
The results of the access test can be obtained in XML or JSON. You can easily use it via server-side programs such as PHP or PERL.
In addition, an IP address can be searched by assigning the IP address to the parameter.
Request URL
http://api.docodoco.jp/v4/search?Parameter name=Parameters Value…
Request Parameters
Parameter names and parameter values are case-sensitive.
※If there is no specification of the parameter, it will be "a default value".
| Parameter name | Description | Value | Initial value |
|---|---|---|---|
| Key1 | API Key1 | alphanumeric characters | ※required |
| Key2 | API Key2 | alphanumeric characters | ※required |
| format | Response format specification | xml,json | xml |
| charset | Character code specification at the time of response | jis,sjis,eucjp,utf8 | utf8 |
| ipadr | IP address specification you want to test | 0.0.0.0～255.255.255.255 | IP address of the access source |
Return Parameter
The following values are shown based on the information of the environment currently being accessed.
The cell which is on of the color is a parameter added in a new version.
| Parameter name | Description | Value |
|---|---|---|
| IP | IP address | now loading... |
| ContinentCode | Continent Code | now loading... |
| CountryCode | Country Code< | now loading... |
| CountryAName | Country English | now loading... |
| CountryJName | Country Japanese | now loading... |
| PrefCode | Prefecture Code | now loading... |
| RegionCode | Region Code | now loading... |
| PrefAName | Prefecture Roman | now loading... |
| PrefJName | Prefecture Japanese | now loading... |
| PrefLatitude | Prefecture Latitude | now loading... |
| PrefLongtude | Prefecture Longitude | now loading... |
| PrefCF | Prefecture Value | now loading... |
| CityCode | Municipality Code | now loading... |
| CityAName | Municipality Roman | now loading... |
| CityJName | Municipality Japanese | now loading... |
| CityLatitude | Municipality Latitude | now loading... |
| CityLongtude | Municipality Longtude | now loading... |
| CityCF | Municipality Value | now loading... |
| BCFlag | Organization Company flag | now loading... |
| OrgCode | Organization Code | now loading... |
| OrgOfficeCode | Organization main/branch office flag | now loading... |
| OrgIndependentCode | Organization self-employed business flag | now loading... |
| OrgName | Organization name | now loading... |
| OrgPrefCode | Organization Prefecture code | now loading... |
| OrgCityCode | Organization Municipality code | now loading... |
| OrgZipCode | Organization Zip code | now loading... |
| OrgAddress | Organization Address | now loading... |
| OrgTel | Organization Tel | now loading... |
| OrgFax | Organization Fax | now loading... |
| OrgIpoType | Organization listing classification flag | now loading... |
| OrgDate | Organization date of the establishment | now loading... |
| OrgCapitalCode | Organization Capital code | now loading... |
| OrgEmployeesCode | Organization Payroll number code | now loading... |
| OrgGrossCode | Organization Sales amount code | now loading... |
| OrgPresident | Organization Representative name | now loading... |
| OrgIndustrialCategoryL | Organization large classification | now loading... |
| OrgIndustrialCategoryM | Organization middle classification | now loading... |
| OrgIndustrialCategoryS | Organization small classification | now loading... |
| OrgIndustrialCategoryT | Organization fine classification | now loading... |
| OrgDomainName | Organization domain name（based on an organization data） | now loading... |
| OrgDomainType | Organization domain type | now loading... |
| OrgUrl | Organization URL | now loading... |
| OrgLatitude | Organization latitude | now loading... |
| OrgLongitude | Organization longitude | now loading... |
| LineCode | Line Code | now loading... |
| LineJName | Line Japanese | now loading... |
| LineCF | Line value | now loading... |
| TimeZone | TimeZone | now loading... |
| ProxyFlag | ProxyFlag | now loading... |
| TelCode | area code（based on an organization data） | now loading... |
| StockTickerNumber | StockTickerNumber | now loading... |
| DomainName | DomainName（based on an IP address） | now loading... |
| DomainType | DomainType | now loading... |
Result
Please check the DEMO data.
REST API Error
If an error occurs, the following information will be returned.
| Type | Status | Message | Detail |
|---|---|---|---|
| Authentication | 401 | Unauthorized | APIキーの認証に失敗 It is failed by the certification of the API key |
Unauthorizedの場合
<?xml version="1.0" encoding="utf-8"?><docodoco><status>401</status><message>Unauthorized</message></docodoco>
Comes with an IP address database of the highest Japanese quality. Compatible with 4 billion IPv4 addresses worldwide.