상가업소개방포털 > OpenAPI > OpenAPI 매뉴얼 > 서비스 명세
서비스 개요
| 서비스명 | 소상공인 상가업소 정보서비스 |
|---|---|
| 서비스설명 | 소상공인 창업 기초 자료로써 앱/웹 개발 등 상가정보 활용성을 확대하고자 상가업소 정보를 제공합니다. |
| 서비스방식 | 공공데이터포털인 data.go.kr을 통해서 Restful 방식으로 서비스 합니다. |
오퍼레이션 목록
| 번호 | 구분 | 오퍼레이션 | 오퍼레이션명 | 오퍼레이션설명 |
|---|---|---|---|---|
| 1 | 상권 | storeZoneOne | 지정 상권조회 | 입력한 상권번호에 해당하는 상권좌표 제공(전국 약 1,200개 주요상권의 영역좌표를 제공) |
| 2 | storeZoneInRadius | 반경내 상권조회 | 원형 안에 포함된 상권을 조회 (지정한 위치를 중심으로 반경에 포함되는 상권 지도 출력이 필요한 경우를 위해 설계된 오퍼레이션) | |
| 3 | storeZoneInRectangle | 사각형내 상권조회 | 사각형 안에 포함된 상권을 조회 (앱의 화면 사각영역 등 사각형 바운더리에 포함되는 상권 지도 출력이 필요한 경우를 위해 설계된 오퍼레이션) | |
| 4 | storeZoneInAdmi | 행정구역 단위 상권조회 | 행정구역 안에 포함된 상권을 조회 (시도, 시군구, 행정동에 포함되는 상권 지도 출력이 필요한 경우를 위해 설계된 오퍼레이션) | |
| 5 | 상가업소 | storeOne | 단일 상가업소 조회 | 상가업소번호에 대한 업소정보를 조회 (단일 업소정보를 출력이 필요한 경우를 위해 설계된 오퍼레이션) |
| 6 | storeListInBuilding | 건물단위 상가업소 조회 | 건물관리번호에 대한 업소정보를 조회 (동일 건물내에 있는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 7 | storeListInPnu | 지번단위 상가업소 조회 | PNU코드에 대한 업소정보를 조회 (동일한 지번에 있는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 8 | storeListInDong | 행정동 단위 상가업소 조회 | 행정동코드에 대한 업소정보를 조회 (동일한 행정동에 있는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 9 | storeListInArea | 상권내 상가업소 조회 | 상권번호에 대한 업소정보를 조회 (동일한 상권영역에 포함되는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 10 | storeListInRadius | 반경내 상가업소 조회 | 원형 안에 포함된 업소정보를 조회 (지정한 위치를 중심으로 반경에 포함되는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 11 | storeListInRectangle | 사각형내 상가업소 조회 | 사각형 안에 포함된 업소정보를 조회 (앱의 화면 사각영역 등 사각형 바운더리에 포함되는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 12 | storeListInPolygon | 다각형내 상가업소 조회 | 다각형 안에 포함된 업소정보를 조회 (임의의 상권영역을 그린 다각형 안에 포함되는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 13 | storeListInUpjong | 업종별 상가업소 조회 | 지정 업종에 속한 업소정보를 조회 (지정한 업종에 해당하는 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 14 | storeListByDate | 수정일자기준 상가업소 조회 | 수정일자 기준으로 업소정보를 조회 (수정일자를 기준으로 신규, 수정, 삭제된 업소목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 15 | reqStoreModify | 상가업소정보 변경요청 | 잘못된 업소정보 수정을 요청하는 기능 (업소정보 정정이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 16 | 업종코드 | largeUpjongList | 상권정보업종 대분류 조회 | 상권정보업종 대분류 코드 목록을 조회 (대분류 업종코드 목록이 필요한 경우를 위해 설계된 오퍼레이션) |
| 17 | middleUpjongList | 상권정보업종 중분류 조회 | 상권정보업종 중분류 코드 목록을 조회 (지정한 대분류에 속하는 중분류 업종코드 목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 18 | smallUpjongList | 상권정보업종 소분류 조회 | 상권정보업종 소분류 코드 목록을 조회 (지정한 중분류에 속하는 소분류 업종코드 목록이 필요한 경우를 위해 설계된 오퍼레이션) |
|
| 19 | 행정구역 코드 | baroApi | 행정구역 조회 | 행정 경계 조회(명칭변경) 오퍼레이션 |
응답 메시지 코드표 (공공데이터포털 제공)
| 에러코드 | 에러메세지 | 설명 |
|---|---|---|
| 00 | NORMAL_CODE | 정상 |
| 01 | APPLICATION_ERROR | 어플리케이션 에러 |
| 02 | DB_ERROR | 데이터베이스 에러 |
| 03 | NODATA_ERROR | 데이터없음 에러 |
| 04 | HTTP_ERROR | HTTP 에러 |
| 05 | SERVICETIMEOUT_ERROR | 서비스 연결실패 에러 |
| 10 | INVALID_REQUEST_PARAMETER_ERROR | 잘못된 요청 파라메터 에러 |
| 11 | NO_MANDATORY_REQUEST_PARAMETERS_ERROR | 필수요청 파라메터가 없음 |
| 12 | NO_OPENAPI_SERVICE_ERROR | 해당 오픈API서비스가 없거나 폐기됨 |
| 20 | SERVICE_ACCESS_DENIED_ERROR | 서비스 접근거부 |
| 21 | TEMPORARILY_DISABLE_THE_SERVICEKEY_ERROR | 일시적으로 사용할 수 없는 서비스 키 |
| 22 | LIMITED_NUMBER_OF_SERVICE_REQUESTS_EXCEEDS_ERROR | 서비스 요청제한횟수 초과에러 |
| 30 | SERVICE_KEY_IS_NOT_REGISTERED_ERROR | 등록되지 않은 서비스키 |
| 31 | DEADLINE_HAS_EXPIRED_ERROR | 기한만료된 서비스키 |
| 32 | UNREGISTERED_IP_ERROR | 등록되지 않은 IP |
| 33 | UNSIGNED_CALL_ERROR | 서명되지 않은 호출 |
| 99 | UNKNOWN_ERROR | 기타에러 |
