공공데이터포털 오픈 API 신청 및 활용 가이드

이 가이드에서 배우는 것

**오픈 API(Open API)**란 공공기관이나 기업이 자신들의 데이터를 외부 개발자도 사용할 수 있도록 공개해 놓은 인터페이스입니다. 공공데이터포털(data.go.kr)은 정부와 공공기관이 보유한 다양한 데이터를 API 형태로 제공하는 사이트입니다.

이 가이드를 따라 하면 다음을 직접 경험할 수 있습니다.

• 공공데이터포털에서 원하는 데이터를 검색하는 방법
• 오픈 API 사용을 신청하고 인증키를 발급받는 방법
• 발급받은 인증키로 실제 API를 호출해 데이터를 받아보는 방법
• API 호출이 실패했을 때 원인을 확인하는 방법

💡 학습 포인트: 대부분의 오픈 API는 "신청 → 인증키 발급 → 인증키를 포함해 요청 → 응답(JSON/XML) 받기"라는 동일한 흐름을 가집니다. 이 흐름을 한 번 익히면 다른 공공 API나 민간 API를 사용할 때도 그대로 적용할 수 있습니다.

---

목차

1. 사이트 접속
2. 오픈 API 검색 및 신청
3. 신청 내역 확인
4. API 활용
5. 학습 정리

---

1. 사이트 접속

1. https://www.data.go.kr 접속
2. 회원가입
3. 로그인

📌 왜 회원가입이 필요할까요? 공공데이터포털은 API 사용자별로 별도의 인증키를 발급합니다. 이는 누가 API를 얼마나 호출하는지 추적하고, 트래픽이 과도할 경우 관리하기 위한 목적입니다. 대부분의 API 서비스가 이런 방식(회원가입 → 인증키 발급 → 인증키로 요청)을 사용합니다.

---

2. 오픈 API 검색 및 신청

1. 공공데이터 > 데이터목록 이동
2. 검색창에 중소기업 검색
3. 오픈 API 클릭
   • 참고: 검색 결과에는 파일 형태로 제공되는 데이터(엑셀, CSV 등)와 API로 제공되는 데이터가 함께 나옵니다. 실시간으로 데이터를 받아 프로그램에 연동하려면 오픈 API를 선택해야 합니다.
4. 목록 중 원하는 글 선택 후 활용신청
   • 예: 중소기업은행_월평균&연평균 환율 정보
5. 활용목적 입력
   • 웹 사이트 개발 체크
   • 설명 기술: 공공데이터 API 연동을 위한 샘플 작성
   • 이용허락범위 동의 체크
   • 활용 신청하기 클릭

📌 활용목적을 입력하는 이유: 공공데이터는 예산으로 운영되기 때문에, 어떤 목적으로 데이터가 사용되는지 파악하기 위해 활용목적을 요구합니다. 교육이나 학습 목적으로 사용하는 경우 사실대로 간단히 작성하면 됩니다.

---

3. 신청 내역 확인

1. 마이페이지 클릭
   • 오픈 API 활용 현황 > 활용 중 선택
2. 메뉴로 이동
   • 데이터 활용 > Open API > 활용신청 현황

📌 API 중에는 신청 즉시 승인되는 것과, 관리기관의 별도 심사가 필요한 것이 있습니다. 상태가 "활용 중"으로 표시되어야 실제로 인증키가 정상 작동합니다. "승인대기" 상태라면 사용이 아직 불가능합니다.

---

4. API 활용

1. 신청한 목록 중 원하는 API 선택
2. 서비스 정보 확인
   • End Point: API를 호출할 주소 (예: https://apis.data.go.kr/...)
   • 일반 인증키: 요청할 때마다 함께 전달해야 하는 인증 값
   📌 End Point와 인증키란? End Point는 데이터를 요청하는 주소(URL)이고, 인증키(서비스키)는 "이 요청을 보낸 사람이 누구인지" 증명하는 값입니다. 웹 브라우저 주소창에 End Point + 인증키 + 필요한 파라미터를 조합해 입력하면, 그 결과로 데이터(JSON 또는 XML)를 돌려받는 구조입니다.
3. 테스트
   • 활용신청 상세기능정보에서 열기 클릭
   • serviceKey에 일반 인증키를 복사해서 입력
   • 미리보기에서는 입력하지 않아도 작동함 (사이트에서 자동으로 넣어주는 경우가 많음)
   • 미리보기 클릭
   • 결과 확인
   📌 미리보기 기능의 의미: 실제 코드를 작성하기 전에, API가 정상적으로 데이터를 반환하는지 웹 페이지에서 먼저 확인할 수 있는 기능입니다. 이 단계에서 정상적으로 결과가 나온다면, 이후 Python이나 JavaScript 같은 프로그래밍 언어로 동일한 요청을 보내도 같은 결과를 받을 수 있습니다.

오류 확인 및 대응 방법

결과에 아래와 같이 나오면 공공데이터 API 쪽 문제로 판단할 수 있습니다.

{
  "response": {
    "header": {
      "resultCode": "04",
      "resultMsg": "NO_MANDATORY_REQUEST_PARAMETERS_ERROR"
    },
    "body": {
      "items": {},
      "numOfRows": 0,
      "pageNo": 0,
      "totalCount": 0
    }
  }
}

**resultCode: "04"**는 필수 파라미터가 빠졌다는 의미입니다. 인증키를 정확히 입력했는데도 이런 결과가 나온다면, 코드나 입력값의 문제가 아니라 공공데이터 API 자체(문서화 오류, 서버 문제 등)에 문제가 있을 가능성이 있습니다.

이런 경우 다음 중 하나를 추천합니다.

• 공공데이터포털 쪽에 문의하기
• 다른 API로 연동하기

💡 학습 포인트: 처음 API를 배울 때는 "내가 뭘 잘못 입력했나?"라고 먼저 생각하게 되지만, 공공데이터 API는 문서와 실제 동작이 다르거나 오류가 있는 경우가 종종 있습니다. 파라미터를 정확히 입력했는데도 계속 같은 오류가 난다면, 다른 API로 바꿔서 연습하는 것도 좋은 학습 전략입니다.

---

학습 정리

이 실습을 통해 익힌 오픈 API 활용의 기본 흐름은 다음과 같습니다.

1. 사이트 가입/로그인
2. 원하는 데이터(API) 검색
3. 활용 신청 → 인증키 발급
4. End Point + 인증키 + 파라미터로 요청
5. JSON/XML 형태의 응답 데이터 확인

이 흐름은 공공데이터포털뿐 아니라 대부분의 오픈 API(날씨, 지도, 환율, 뉴스 등)에서 공통적으로 사용됩니다. 이후에는 이 인증키를 Python의 requests 라이브러리 등으로 직접 코드에서 호출하는 실습으로 이어갈 수 있습니다.

---

체크리스트

• [ ] data.go.kr 회원가입 및 로그인 완료
• [ ] 오픈 API의 의미와 인증키가 필요한 이유를 이해했다
• [ ] 원하는 오픈 API 검색 및 활용신청 완료
• [ ] 마이페이지에서 신청 내역(활용 중 여부) 확인
• [ ] End Point 및 일반 인증키의 역할을 이해했다
• [ ] serviceKey 입력 후 미리보기 테스트 완료
• [ ] 오류 발생 시 원인이 내 입력값인지, API 자체 문제인지 구분할 수 있다

공공데이터포털_오픈API_활용가이드.md.pdf

0.32MB

공공데이터포털_오픈API_활용가이드_기본버전.md.pdf

0.18MB