오픈 API란 API를 외부에 공개한 것으로 일반적으로 웹 서비스 형태로 공개한 것을 말합니다.
위키피디아에서는 API를 "응용프로그램에서 사용할 수 있는 운영체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있도록 만든 인터페이스"로 정의하고 있습니다.
즉, 원래는 운영체제나 언어가 제공하는 기능을 제어할 수 있는 인터페이스였으나 이를 웹 서비스에서는 특정 서비스를 이용할 수 있는 인터페이스를 API라 지칭하였습니다.
또한, 이것을 외부에서 사용할 수 있도록 공개한 것이 오픈 API, 웹서비스의 개방지향적인 성격을 잘 나타내고 있습니다. 일반적으로 오픈서비스 API, 웹서비스 API등의 용어와 혼용하여 비슷한 의미로 사용되고 있습니다.
API 제공 데이터
기능
설정
기반정보
정류소 정보
노선 기본정보(노선이름, 기점, 종점, 운행간격, 노선타입) 제공
노선번호
정류소 기본정보(정류소 명칭, 위치값, ARS 번호) 제공
노선-정류소 정보
노선에 해당하는 노선의 경유 정류소 리스트 제공
실시간 정보
버스도착정보 목록
해당 정류소의 버스 도착정보 제공
노선-버스위치 정보
해당 노선의 버스 위치 제공
서비스명(Service Name)
노선정보 - lineinfo
샘플 URL(Request URL)
XML Data : http://api.hampyeong.go.kr/xml/lineInfo/serviceKey
JSON Data : http://api.hampyeong.go.kr/json/lineInfo/serviceKey
요청변수(Request Parameter)
변수명
변수 타입
설명
ServiceKey
String(필수)
발급 받은 키값
출력 결과 필드(Response Field)
태그명
명칭
설명
LINE_LIST
LINE
LINE_ID
노선아이디
LINE_NAME
노선이름
DIR_UP_NAME
기점(정류소명칭)
DIR_DOWN_NAME
종점(정류소명칭)
LINE_KIND
노선종류
1:급명간선, 2:간선, 3:지선
ROW_COUNT
레코드 개수
서비스명(Service Name)
정류소 정보 - busstopinfo
샘플 URL(Request URL)
XML Data : http://api.hampyeong.go.kr/xml/stationInfo/serviceKey
JSON Data : http://api.hampyeong.go.kr/json/stationInfo/serviceKey
요청변수(Request Parameter)
변수명
변수 타입
설명
ServiceKey
String(필수)
발급 받은 키값
출력 결과 필드(Response Field)
태그명
명칭
설명
STATION_LIST
STATION
BUSSTOP_ID
정류소번호
BUSSTOP_NAME
정류소이름
NAME_E
정류소이름(영문)
LONGITUDE
위도
LATITUDE
경도
ARS_ID
ARS 번호
NEXT_BUSSTOP
정류소 방향
ROW_COUNT
레코드 개수
서비스명(Service Name)
노선-정류소 정보 - Line-BusstopInfo
샘플 URL(Request URL)
XML Data : http://api.hampyeong.go.kr/xml/lineStationInfo/serviceKey/lineId
JSON Data : http://api.hampyeong.go.kr/json/lineStationInfo/serviceKey/lineId
요청변수(Request Parameter)
변수명
변수 타입
설명
ServiceKey
String(필수)
발급 받은 키값
lineId
String(필수)
노선번호
출력 결과 필드(Response Field)
태그명
명칭
설명
BUSSTOP_LIST
BUSSTOP
LINE_ID
노선번호
LINE_NAME
노선이름
BUSSTOP_ID
정류소번호
BUSSTOP_NAME
정류소이름
LONGITUDE
위도
LATITUDE
경도
ARS_ID
ARS 번호
RETURN_FLAG
정류장구분
1:운행정류장, 2:시작기점, 3:종점(회차지), 4:종료기점, 9:교차로
ROW_COUNT
레코드 개수
서비스명(Service Name)
도착정보 - ArriveInfo
샘플 URL(Request URL)
XML Data : http://api.hampyeong.go.kr/xml/lineStationInfo/serviceKey/lineId
JSON Data : http://api.hampyeong.go.kr/json/lineStationInfo/serviceKey/lineId
요청변수(Request Parameter)
변수명
변수 타입
설명
ServiceKey
String(필수)
발급 받은 키값
lineId
String(필수)
노선번호
출력 결과 필드(Response Field)
태그명
명칭
설명
BUSSTOP_LIST
BUSSTOP
LINE_ID
노선번호
LINE_NAME
노선이름
BUS_ID
버스번호
CURR_STOP_ID
현재 정류소 번호
BUSSTOP_NAME
정류소이름
REMAIN_MIN
차량 도착 예상 시간
단위:분
REMAIN_STOP
차량 남은 정류소 개수
DIR_START
출발지
DIR_END
도착지
DIR_PASS
경유지
LOW_BUS
저상버스
0:일반, 1:저상
ENG_BUSSTOP_NAME
정류소이름(영문)
ARRIVE_FLAG
도착 코드
ROW_COUNT
레코드 개수
서비스명(Service Name)
노선-버스위치 정보 - ArriveInfo
샘플 URL(Request URL)
XML Data : http://api.hampyeong.go.kr/xml/busLocationInfo/serviceKey/lineId
JSON Data : http://api.hampyeong.go.kr/json/busLocationInfo/serviceKey/lineId