[.Net] 공공데이터포털 API 사용하여 C#에서 실시간 버스 위치 조회하기(예제 포함)

공공데이터포털 API란?

우선 공공데이터에 대한 정의부터 알아보겠습니다.

공공데이터란 공공기관이 만들어내는 모든 자료나 정보, 국민 모두의 소통과 협력을 이끌어내는 공적인 정보를 말합니다. 각 공공기관이 보유한 공공데이터 목록과 국민에게 개방할 수 있는 공공데이터를 포털에 등록하면 모두가 공유할 수 있는 양질의 공공데이터로 재탄생하게 됩니다. -출처: 공공데이터포털

그리고 공공데이터포털의 정의는 다음과 같습니다.

공공데이터포털은 공공기관이 생성 또는 취득하여 관리하고 있는 공공데이터를 한 곳에서 제공하는 통합 창구입니다. 포털에서는 국민이 쉽고 편리하게 공공데이터를 이용할 수 있도록 파일 데이터, 오픈 API, 시각화 등 다양한 방식으로 제공하고 있으며, 누구라도 쉽고 편리한 검색을 통해 원하는 공공데이터를 빠르고 정확하게 찾을 수 있습니다. -출처: 공공데이터포털

즉, 대한민국 국민이라면 공공데이포털을 통해 공개되어있는 모든 자료에 접근하여 사용할 수 있습니다. 그리고 오픈 API 사용 신청 허가를 받았다면, 오픈 API를 통해 공공데이터를 조회하는 프로그램을 개발할 수 있습니다.

공공데이터포털 오픈 API 제공 예시

공공데이터포털 오픈 API 신청하기

공공데이터포털 홈페이지에 접속하여 회원가입부터 진행합니다.

홈페이지: www.data.go.kr/index.do

공공데이터 포털

회원가입 후 데이터 찾기 메뉴의 데이터 목록 메뉴를 클릭합니다.

홈페이지 데이터 목록 메뉴 화면

그리고 검색란에 버스 위치를 검색해 보겠습니다. 아래 화면은 버스 위치 키워드에 대한 결과를 보여주는데, 4,993건의 오픈 API 검색 결과가 존재합니다.

'버스 위치' 키워드 검색 결과 화면

저는 테스트로 경기도에서 제공하는 버스 위치 정보 조회 서비스를 선택했습니다. 오픈 API를 신청하려면, 아래와 같은 화면에서 우측 상단의 활용 신청 버튼을 클릭합니다.

선택한 서비스의 오픈 API 정보

오픈 API를 신청하기 위해서는 아래와 같은 형식으로 활용 목적을 작성해야 합니다.

오픈 API 활용 신청 방법

신청이 완료되면 아래와 같은 팝업 메시지가 표시됩니다.

오픈 API 활용 신청 완료 메시지

신청 완료 후 인증이 가능해지면, 마이페이지에서 아래와 같이 서비스를 확인할 수 있습니다.

오픈 API 서비스 승인 목록

서비스를 클릭하면 아래와 같이 서비스 유형과 인증키 그리고 참고 문서가 표시됩니다.

오픈 API 서비스 상세 화면

참고 문서에는 아래와 같이 개발하는데 필요한 상세한 내용이 작성되어 있습니다.

오픈 API 참고 문서 내용

오픈 API 요청 및 결과 분석 방법

해당 서비스 페이지에 아래와 같은 내용이 있습니다.

오픈 API 요청 및 결과 형태

요청 변수는 다음과 같습니다.

항목명	항목명	항목구분	샘플 데이터	항목 설명
인증키	serviceKey	필수	마이 페이지에서 확인	공공데이터포털에서 발급 받은 인증키
노선 아이디	routeId	필수	233000031	노선 ID

인증키는 마이 페이지에서 활용 신청한 서비스에서 확인이 가능합니다. 노선 아이디의 경우 샘플로 233000031이 제공되는데요. 이 노선 ID는 다른 요청으로 얻을 수 있습니다. 예를 들어, 운행지역별 노선 번호 목록을 조회하면 노선 번호 목록과 노선 ID를 얻을 수 있습니다. 자세한 내용은 아래 페이지에서 확인하세요.

www.gbis.go.kr/gbis2014/publicService.action?cmd=mBusRouteArea

운행지역별 노선번호 목록조회-매뉴얼-공유서비스 | 경기버스정보

출력 결과는 다음과 같습니다.

항목명	항목명	항목 구분	항목 설명
	msgBody
버스 위치 정보 목록	busLocationList	0..n	버스 위치 정보 목록
노선 아이디	routeId	필수	노선 아이디
정류소 아이디	stationId	필수	정류소 아이디
정류소 순번	stationSeq	필수	노선의 정류소 순번
막차 여부	endBus	필수	막차 여부(0:일반, 1:막차)
저상 버스 여부	lowPlate	필수	저상 버스 여부(0:일반, 1:저상)
차량 번호	plateNo	필수	차량 번호
차종	plateType	필수	차량 종류(0:정보 없음, 1:소형 승합차, 2: 중형 승합차, 3:대형 승합차, 4:2층 버스)
차량 빈자리 수	remainSeatCnt	필수	빈자리수(-1:정보없음, 0~:빈자리 수)

예시 결과는 다음과 같습니다.

<endBus>0</endBus>
<lowPlate>0</lowPlate>
<plateNo>경기70사1143</plateNo>
<plateType>3</plateType>
<remainSeatCnt>45</remainSeatCnt>
<routeId>233000031</routeId>
<stationId>120000059</stationId>
<stationSeq>32</stationSeq>

위 출력 결과표와 비교해 보면 쉽게 해석할 수 있겠죠?

C#으로 실시간 버스 위치 조회하기

이제 본격적으로 코드를 작성해 보겠습니다. ExamBusLocation 이름의 Windows Forms 앱 프로젝트를 생성합니다.

Windows Forms 앱 프로젝트 생성

UI는 아래와 같이 간단하게 ListView와 Button으로 구성했습니다.

WinForm UI 구성

오픈 API를 요청하는 코드는 다음과 같습니다.

using System.Net;
using System.IO;
using System.Xml;

namespace ExamBusLocation
{
    public partial class Form1 : Form
    {
    	const string targetURL = "http://openapi.gbis.go.kr/ws/rest/buslocationservice";
        const string serviceKey = ""; //마이 페이지에서 자신의 인증키 입력.
        const string routeid = "233000031"; //버스 노선 ID
    
    //...
    
    public static string getResults()
    {
    	string result = string.Empty;

		try
		{
        	WebClient client = new WebClient();
			string url = string.Format(@"{0}?serviceKey={1}&routeId={2}", targetURL, serviceKey, routeid);
			using (Stream data = client.OpenRead(url))
			{
            	using (StreamReader reader = new StreamReader(data))
            	{
					string s = reader.ReadToEnd();
					result = s;

					reader.Close();
					data.Close();
				}
			}
		}
		catch (Exception exc)
		{
			MessageBox.Show(exc.Message);
		}

		return result;
		}
		//...
	}   
}

코드가 너무 간단하죠? 딱히 설명할 내용도 없어 보입니다. 마지막으로 ListView에 정보를 출력하는 코드입니다.

private void buttonRefresh_Click(object sender, EventArgs e)
{
	string result = getResults();

	XmlDocument xml = new XmlDocument();
	xml.LoadXml(result);
	XmlNodeList list = xml.GetElementsByTagName("busLocationList");

	listViewResults.Items.Clear();
	int idx = 0;
	foreach (XmlNode bus in list)
	{
		ListViewItem item = new ListViewItem((idx++).ToString());
		item.SubItems.Add(bus["plateNo"].InnerText);
		string endBus = "N";
		if (bus["endBus"].InnerText == "1")
			endBus = "Y";
		item.SubItems.Add(endBus);

		item.SubItems.Add(bus["remainSeatCnt"].InnerText);

		listViewResults.Items.Add(item);
	}
}

XML 데이터에서 busLocationList를 얻은 후 각 버스 목록에서 데이터를 추출하면 되겠습니다. 코드 실행 결과는 다음과 같습니다.

조회 결과

아래 샘플 코드를 첨부했습니다. 자세한 코드 사용은 아래 파일을 참고해 주세요.

ExamBusLocation.zip

0.01MB