User Guide
OpenAPI Introduction
Property Information
This API service provides data in XML or JSON format for external use of data on property information.
Spatial Information
It provides two types of API services for geospatial information using standard protocols established by the Open Geospatial Consortium (OGC).
▪ WMS (Web Map Service) service enables you to utilize map images (png, jpeg, gif) generated from geographic data.
▪ WFS (Web Feature Service) service allows you to utilize geographic feature data (with vector shapes and attributes).
Authorization Key Request
OpenAPI service is available after issuing the authentication key through the application process.
OpenAPI application can be made through the public data portal.(www.data.go.kr)
You can go to the public data portal and sign up at Standard Data > Ecosystem and Nature Map Evaluation Information > OpenAPI.
Example of Creating a Request URL
OpenAPI request URL is created by combining 'request URL by service' and 'request item'.
Refer to the Request Items tab for the requested item by service, and enter a valid authentication key issued after applying for the service key.
Property Information
Service results can be received in XML or JSON format, and you can specify the output method of the desired response results as shown in the example below.
Type Use the request item to specify the output method of the desired response results, and if you do not specify the output method of the response results, the xml format is applied by default.
▪ JSON Type : http://apis.data.go.kr/B553084/Request by Service URL?type=json&serviceKey=AuthenticationKey[&Request Item=Value]
▪ XML Type : http://apis.data.go.kr/B553084/Request by Service URL?type=xml&serviceKey=AuthenticationKey[&Request Item=Value]
Spatial Information
▪ http://apis.data.go.kr/B553084/Request by Service URL?serviceKey=AuthenticationKey[&Request Item=Value]
Request by Service URL
| Service | Details Function | Request URL |
|---|---|---|
| Ecosystem and Nature Map | WMS Check | ecoapi/EcologyzmpService/wms/getEcologyzmpWMS |
| WFS Check | ecoapi/EcologyzmpService/wfs/getEcologyzmpWFS | |
| Property Check | ecoapi/EcologyzmpService/attr/getEcologyzmpAttr | |
| Vegetation Assessment | WMS Check | ecoapi/ActvnmapService/wms/getActvnmapWMS |
| WFS Check | ecoapi/ActvnmapService/wfs/getActvnmapWFS | |
| Property Check | ecoapi/ActvnmapService/attr/getActvnmapAttr | |
| Wetland Assessment | WMS Check | ecoapi/SmldevalService/wms/getSmldevalWMS |
| WFS Check | ecoapi/SmldevalService/wfs/getSmldevalWFS | |
| Property Check | ecoapi/SmldevalService/attr/getSmldevalAttr | |
| Terrain Assessment | WMS Check | ecoapi/TpgrphevalService/wms/getTpgrphevalWMS |
| WFS Check | ecoapi/TpgrphevalService/wfs/getTpgrphevalWFS | |
| Property Check | ecoapi/TpgrphevalService/attr/getTpgrphevalAttr |
Request Item
OpenAPI Request by Service Topics
To configure a valid request URL, the request parameter must be added as a name.value pair, which is in the form of "request item=value" by referring to the requested item information below.
The requested items that exist by service capability can be found on the Request by Service item screen below.
WMS Service Request Item
| Request Item | Required Status | Sample Data | Explanation |
|---|---|---|---|
| serviceKey | Essential | Authentication Key(URL Encode) | Enter the authentication key issued by the public data portal. |
| layers | Option | tbl_opn_eczm | The layer to be displayed on the screen. The value is a comma-separated list of layer names. (See the [List of Layers] tab) |
| srs | Essential | EPSG:5186 | Indicates the coordinate system. Central Point (GRS80) EPSG:5186 Coordinate Systems are supported. |
| bbox | Essential | 314548.9311225004 ,401742.29949240043 ,320867.0145135768 ,409072.0397406582 |
This is the bounding box that defines the extent. Four real numbers consist of commas. |
| width | Essential | 663 | Set the width of the return image to the pixel value (Apply 1024 if it is greater than 1024). |
| height | Essential | 768 | Set the Height of the return image to the pixel value (Apply 1024 if it is greater than 1024). |
| format | Option | png | Return Image Format. It supports png, jpeg, and gif image formats. |
| transparent | Option | false | Determines whether the background of the return image is transparent. The value is true or false, and the default is false. |
| bgcolor | Option | 0xFFFFFF | Determines the background color of the return image. The value is in the form 0xRRGGBB, the default is 0xFFFFFF (white). |
| exceptions | Option | BLANK | Determines how to handle exceptions when they occur. - BLANK: Blank Image - XML[Default]: xml containing error code, name, and description information - INIMAGE : Image with error information |
WFS Service Request Item
| Request Item | Required Status | Sample Data | Explanation |
|---|---|---|---|
| serviceKey | Essential | Authentication Key(URL Encode) | Enter the authentication key issued by the public data portal. |
| typeName | Option | tbl_opn_eczm | A list of the names of one or more feature types being queried, |
| bbox | Option | 314548.9311225004 ,401742.29949240043 ,320867.0145135768 ,409072.0397406582 |
Search for features contained within (or partially across) a rectangle of coordinates. Coordinate order follows the coordinate system used. The general representation is the order of lower coordinates, upper coordinates, and coordinate system. (lc1,lc2,uc1,uc2,Coordinate System) |
| maxFeatures | Option | 10 | The maximum value of features that WFS should return in response to the request. (Maximum Allowable Value : 500) |
| eczmGr | Option | 2 | Request item name differs by service by assessment grade code(1: grade1, 2: grade2, 3: grade3). - Ecosystem and Nature Map: eczmGr - Vegetation Assessment: vtnEvlGr - Wetland Assessment: smldEvlGr - Terrain Assessment: tpgEvlGr |
| ctprvnCd | Option | 47 | Si-Do code (2 out of 10 legal code Si-Do code[2]) You do not need to enter the Si-Do code when entering the Si-Gun-Gu.Eup-Myeon-Dong code. |
| signguCd | Option | 47190 | Si-Gun-Gu code (5 out of 10 legal code Si-Do[2] + Si-Gun-Gu[3] code) You do not need to enter the Si-Gun-Gu code when entering the Eup-Myeon-Dong code. |
| emdCd | Option | 47190250 | Eup-Myeon-Dong code (8 out of 10 legal code Si-Do[2] + Si-Gun-Gu[3] + Eup-Myeon-Dong[3] code) |
Property Service Request Item
| Request Item | Required Status | Sample Data | Explanation |
|---|---|---|---|
| serviceKey | Essential | Authentication Key(URL Encode) | Enter the authentication key issued by the public data portal. |
| numOfRows | Option | 10 | The number of results on a page.(Default: 10) |
| pageNo | Option | 1 | This is the page number.(Default: 1) |
| type | Option | xml | Output method of response result. The value is xml or json, default is xml. |
| eczmGr | Option | 2 | Request item name differs by service by assessment grade code(1: grade1, 2: grade2, 3: grade3). - Ecosystem and Nature Map: eczmGr - Vegetation Assessment: vtnEvlGr - Wetland Assessment: smldEvlGr - Terrain Assessment: tpgEvlGr |
| ctprvnCd | Essential | 47 | Si-Do code (2 out of 10 legal code Si-Do code[2]) You do not need to enter the Si-Do code when entering the Si-Gun-Gu.Eup-Myeon-Dong code. |
| signguCd | Essential | 47190 | Si-Gun-Gu code (5 out of 10 legal code Si-Do[2] + Si-Gun-Gu[3] code) You do not need to enter the Si-Gun-Gu code when entering the Eup-Myeon-Dong code. |
| emdCd | Essential | 47190250 | Eup-Myeon-Dong code (8 out of 10 legal code Si-Do[2] + Si-Gun-Gu[3] + Eup-Myeon-Dong[3] code) |
List of Layers
You can find a list of top-of-the-line layers available from OpenAPI below.
| Service | WMS Layer | WFS Layer | Layer Korean name |
|---|---|---|---|
| 생태·자연도 | tbl_opn_eczm | tbl_opn_eczm | 개방_생태자연도 |
| 식생평가 | tbl_opn_vtn_evl | tbl_opn_vtn_evl | 개방_식생_평가 |
| 습지평가 | tbl_opn_smld_evl | tbl_opn_smld_evl | 개방_습지_평가 |
| 지형평가 | tbl_opn_tpgrph_evl | tbl_opn_tpgrph_evl | 개방_지형_평가 |
Sample Code
Click the sample code button to inquire.