API - 필수 파라미터 살펴보기

현재 교통 서비스를 지원하는 프로젝트를 진행하고 있는데, 수많은 데이터들이 오고가는 과정이 신기했다. 단순하게 어림짐작과 프로그램이 실행되면 '아, 이렇게 되는구나'싶었지, 자세하게는 알고 있지 못했던 터라 어떠한 방식으로 데이터 교환이 되는 것인지 알기 위해서 이 글을 정리하게 되었다.

---

"API(Application Programming  Interface), 응용프로그램 프로그래밍 인터페이스)"

---

- API는 응용프로그램에서 사용할 수 있도록, 운영체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 인터페이스를 뜻한다. (위키백과)

 

  API는 어떠한 응용프로그램에서 데이터를 주고 받기 위한 방법을 의미한다. 어떤 특정 사이트에서 특정 데이터를 공유할 경우 어떠한 방식으로 정보를 요청해야 하는지, 그리고 어떠한 데이터를 제공 받을 수 있을지에 대한 규격들을 API라고 하는 것이다. 

 

  실제로 사례를 보는 것이 더 이해가 빠르기 때문에 현재 프로젝트에 사용하고 있는 오픈 API를 가지고 알아볼 것인데, 현재 사용하고 있는 API에 대해서 먼저 정리하고 다른 API들도 정리해보려고 한다.

---

  현재 진행하고 있는 프로젝트에서 사용하는 API들이다. 이 글에서 정리한 API뿐만 아니라 모든 API들이 파라미터를 요청하면 출력값을 리턴하게 된다. 이때, 출력값을 리턴하기 위해 반드시 필요한 것이 필수 파라미터인데 필수값 레코드에 Y/N으로 필수값 여부에 대하여 표시해주고 있다.

 

도시코드 조회

- 원하는 도시의 고속버스, 시외버스 터미널 / 기차역 터미널 조회를 위해 도시코드 조회가 필요했다.

---

고속버스 터미널 조회

시외버스 터미널 조회

- 도시코드나 터미널명으로 조회하게 되면 그 도시의 버스 터미널이 모두 조회가 가능하다.

---

고속버스 운행정보

시외버스 운행정보

- 버스 운행정보의 필수값은 도시코드(CID)로 버스 터미널을 조회하면 버스터미널의 ID가 리턴되는데 그 터미널의 ID가 필수값이고, 각각 출발 / 도착 지역으로 입력하게 된다.

---

기차역 터미널 조회

- 기차역 터미널 또한 도시코드(CID)나 터미널명을 필수값으로 요청한다.

 

열차, KTX 운행정보 검색

- 버스 운행정보와 마찬가지로 기차역 터미널의 ID를 필수값으로 요청하며, 각각 출발 / 도착 지역으로 입력하게 된다.

---

 

지하철역 전체 시간표 조회

- 여러 요청값들이 있지만 조회할 역코드를 필수값으로 요청한다. 사용자의 사용 여부에 따라, 급행 / 특급 열차의 정보도 요청하여 사용할 수 있다.

---

 

필수값 흐름도