API

김동준·2026년 1월 8일

API (Application Programming Interface)

컴퓨터나 소프트웨어 프로그램끼리 서로 통신하기 위해 정의된 규약(Protocol)입니다. 한 프로그램이 다른 프로그램의 데이터나 기능을 사용하고자 할 때, 어떤 방식으로 요청을 보내고 응답을 받을지 미리 정해놓은 약속된 접점을 의미합니다.

엔드포인트 (Endpoint)

API가 자원에 접근할 수 있도록 제공하는 주소(URL)입니다.

예시: https://api.vworld.kr/req/data

메서드 (Method / HTTP Verb)

요청의 목적을 나타냅니다. 가장 흔히 쓰이는 방식은 다음과 같습니다.

  • GET: 데이터 조회 (가져오기)

  • POST: 새로운 데이터 생성 (보내기)

  • PUT/PATCH: 기존 데이터 수정

  • DELETE: 데이터 삭제

데이터를 가져오는 것이 목적이므로 주로 GET 방식이 사용됩니다.

파라미터 (Parameters)

요청할 때 함께 전달하는 세부 조건입니다.

  • key: 여러분이 발급받은 인증키(가장 중요합니다. 점원이 "당신 누구야?"라고 묻는 것과 같습니다.)

  • data: 어떤 데이터를 가져올지 지정합니다. 읍면동 정보라면 LT_C_ADEMD_INFO라고 적어야 합니다.

  • attrfilter: 특정 조건으로 필터링을 합니다. 예를 들어 "서울시에 있는 읍면동만 보여줘"와 같은 조건을 걸 때 사용합니다.

  • geomfilter: "특정 좌표 주변의 정보만 보여줘"와 같은 위치 기반 조건을 설정합니다.

요청과 응답 (Request & Response)

Request (요청): 클라이언트가 서버에 보내는 메시지입니다. 여기에는 Header(인증 정보 등)와 Body(실제 전달할 데이터)가 포함될 수 있습니다.

Response (응답): 서버가 처리를 마친 후 보내는 결과입니다. 성공 여부를 알려주는 상태 코드(Status Code)와 결과 데이터가 담깁니다.

데이터 형식 (Data Format)

주로 JSON이나 XML 형식을 사용합니다. 최근에는 가독성이 좋고 가벼운 JSON이 표준처럼 쓰입니다

0개의 댓글