지오펜싱 샘플예제

공간검색 API

  • REQUEST ( 공간검색 API )
curl --request GET \
     --url 'https://apis.openapi.sk.com/tmap/geofencing/regions?version=1&page=1&count=5&categories=city_do&searchType=KEYWORD&resCoordType=WGS84GEO&reqCoordType=WGS84GEO&appKey=jhs01-ks981-862sa-91klu' \
     --header 'Accept: application/json'
  • RESPONSE ( 공간검색 API )

Name

Date Type

Mandatory

Example

Description

searchRegionsInfo

Node

N

regionInfo

Node

N

regionId

String

N

regionName

String

N

category

String

N

parentId

String

N

description

String

N

properties

String

N

guName

Node

N

doName

Node

N

viewName

Node

N

  • 공간검색 API RESPONSE ( type : javascript )
function(
{
        "searchRegionsInfo":[
            {
            "regionInfo":{
                "regionId": "22805",
                "regionName": "역삼동",
                "category": "adminDong",
                "parentId": "120910",
                "description": "경기도 용인시 처인구 역삼동",
                "properties":{"guName": "용인시 처인구", "doName": "경기도", "viewName": ""}
            }
        }
    ]
}
)
  • 공간검색 API RESPONSE ( type : json)
{
        "searchRegionsInfo":[
            {
            "regionInfo":{
                "regionId": "22805",
                "regionName": "역삼동",
                "category": "adminDong",
                "parentId": "120910",
                "description": "경기도 용인시 처인구 역삼동",
                "properties":{"guName": "용인시 처인구", "doName": "경기도", "viewName": ""}
            }
        }
    ]
}
  • 공간검색 API RESPONSE ( type : xml)
<?xml version="1.0" encoding="UTF-8"?>
<searchregionsinfo>
    <regioninfo>
        <regionid>22805</regionid>
        <regionname>
            <!--[CDATA[역삼동]]-->
        </regionname>
        <category>
            <!--[CDATA[adminDong]]-->
        </category>
        <parentid>120910</parentid>
        <description>
            <!--[CDATA[경기도 용인시 처인구 역삼동]]-->
        </description>
        <properties>
            <guname>
                <!--[CDATA[용인시 처인구]]-->
            </guname>
            <doname>
                <!--[CDATA[경기도]]-->
            </doname>
            <viewname></viewname>
        </properties>
    </regioninfo>
</searchregionsinfo>
  • Error code index
    | 에러코드 목록은 Web service에서 Guide API의 console에서 확인 할 수 있습니다.

영역조회 API

  • REQUEST ( 영역조회 API )
curl --request GET \
     --url 'https://apis.openapi.sk.com/tmap/geofencing/regions/regionId?version=1&resCoordType=WGS84GEO&appKey=js01s-3h28k-ks719-zhn8z' \
     --header 'Accept: application/json'
  • RESPONSE ( 영역조회 API )

Name

Date Type

Mandatory

Example

Description

type

String

Y

FeatureCollection

geojson 표준 프로퍼티입니다.

features

node

N

포인트 및 라인의 형상 정보입니다. (geojson 표준 규격)

type

string

N

Feature

출발점, 안내점, 경유지, 도착점 정보입니다.

geometry

node

N

형상 정보 입니다. (geojson 표준 규격)

type

String

N

Point

geometry의 type입니다.

coordinates

String

N

좌표 정보입니다.

  • 경도와 위도는 콤마(,)로 구분하여 '[',']'으로 묶어주고
    복수 좌표 역시 콤마로 구분하여 '[',']'으로 묶어줍니다.
    -형식: [[x1좌표, y1좌표], [x2좌표, y2좌표]]

properties

node

N

사용자 정의 프로퍼티 정보입니다. (geojson 표준 규격)

regionId

String

N

366994

영역조회한 regionId 입니다.

regionName

String

N

한강시민공원구리지구

영역조회한 지역명 입니다.

category

String

N

SKM_ZTHEMEA

검색한 카테고리 입니다.
city_do
(old:SIDOP)

  • 시,도 단위 검색

gu_gun
(old : SIGUNP)

  • 시,군,구 단위 검색

legalDong
(old : BDONGP)

  • 법정동 검색

adminDong
(old : HDONGP)

  • 행정동 검색

parentId

String

N

  • 상위 지역 regionId 입니다.

description

String

N

  • 상세 설명 입니다.

guName

String

N

  • 해당 영역을 포함하는 시/군/구 명칭 입니다.

doName

String

N

  • 해당 영역을 포함하는 시/도 명칭 입니다.

viewName

number

N

3000m

  • 조회된 영역의 view 이름
  • 영역조회 API RESPONSE ( type : json )
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              127.17706597988776,
              37.25484751894829
            ],
            [
              127.17774033822732,
              37.25473791575879
            ]
          ]
        ]
      },
      "properties": {
        "regionId": "22805",
        "regionName": "역삼동",
        "category": "adminDong",
        "parentId": "120910",
        "description": "경기도 용인시 처인구 역삼동",
        "guName": "용인시 처인구",
        "doName": "경기도",
        "viewName": ""
      }
    }
  ]
}
  • 영역조회 API RESPONSE ( type : javascript )
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              127.17706597988776,
              37.25484751894829
            ],
            [
              127.17774033822732,
              37.25473791575879
            ]
          ]
        ]
      },
      "properties": {
        "regionId": "22805",
        "regionName": "역삼동",
        "category": "adminDong",
        "parentId": "120910",
        "description": "경기도 용인시 처인구 역삼동",
        "guName": "용인시 처인구",
        "doName": "경기도",
        "viewName": ""
      }
    }
  ]
}
  • Error code index
    | 에러코드 목록은 Web service에서 Guide API의 console에서 확인 할 수 있습니다.