Guide: Converting KOICA OpenAPI Data to Files Using Python (1)

Guide: Python Code for Converting KOICA OpenAPI Data to Files | Excels
KOICA 오픈API데이터를 파일데이터로 변환하는 파이썬 코드 가이드

1. Name of data used: KOICA ODA Project Information - KF Public Diplomacy Projects
(한국국제협력단_KOICA ODA 사업정보_KF-공공외교 사업정보)

Google Colab: https://colab.research.google.com/drive/10BISX58wfqgf2dZSR-izYJjzB1XIpEyU?usp=sharing

 

 

KOICA OpenAPI Data (19 Records) from Public Data Portal

공공데이터포털 KOICA 오픈API 데이터 (19건)

 

 

데이터명: 한국국제협력단_KOICA ODA 사업정보_KF-공공외교 사업정보

 

 

1. API 호출 URL 주소 확인

• API 호출 URL 주소는 데이터 상세설명에 기재된 서비스URL으로 확인이 가능합니다.
• API URL은 'getOdaBusinessInfoList 엔드포인트(Endpoint)를 포함한 전체 주소를 필요로 합니다. 따라서 [KOICA-ODA 사업정보 KF-공공외교 사업정보] 데이터처럼 (1) 요청주소와 (2) 서비스URL이 있으면 엔드포인트를 포함한 주소를 사용하시면 되십니다. 따라서 이경우는 요청주소를 활용하시면 되십니다.
• 요청주소: http://apis.data.go.kr/B260003/OdaBusinessInfoService/getOdaBusinessInfoList

 

2. 일반 인증키(Decoding) 사용 - 요청해서 부여 받은 인증키로 대체하여 기입하셔야 합니다!

• 예시: kGUKTo8Mh/FFlsfrtw7HOGgfkKwZkXH8TNNzDcOdXpdg4I5RrbSu89yzFp9PLET6xzVDhwQU5VyRCUKIoG2YQg==

 

3. 요청변수(Request Parameter) 입력을 위한 샘플코드 확인

 

 

 

4. 전체 데이터 호출을 위한 코드 실행

 

 

요청 파라미터의 영향을 받지 않고 모든 데이터를 수집하기 위해 사용한 접근 방식은 아래의 작업을 기초로 합니다.

 

• 기본 설정: API의 URL과 서비스 키 설정
• 데이터 수집 함수: fetch_all_data 함수는 모든 페이지의 데이터를 수집합니다. while True 루프를 사용하여 페이지 번호를 증가시키며 데이터 요청
• 반복 요청: 각 요청마다 numOfRows를 1000으로 설정하여 최대한 많은 데이터를 한 번에 요청합니다.
• 응답 처리: 응답 데이터가 없으면 루프를 종료하고, 응답 데이터가 있으면 이를 all_data 리스트에 추가
• 에러 처리: API 요청이 실패할 경우 루프를 종료하고 에러 메시지를 출력
• 데이터 저장: 수집된 데이터를 데이터프레임으로 변환하고 엑셀 파일로 저장

 

 

URL 분석

 

http://openapi.koica.go.kr/api/ws/BsnsService/getBsnsInfoList

 

 

• 통신 프로토콜 : http (또는 https)
• 도메인 : openapi.koica.go.kr 
• 기본 경로(Base URL) : http://openapi.koica.go.kr/api
• End Point : /ws/BsnsService
• 통신 프로토콜 메소드 : getBsnsInfoList

 

* 엔드 포인드(End Point)는 API 서비스 내에서 특정 서비스나 리소스를 지칭하는 부분으로 API의 호출 주소입니다.

* 통신 프로토콜 메소드는 호출할 특정 기능이나 작업을 나타내며, 일반적으로 API의 메소드(method) 또는 액션(action)으로 호칭됩니다.

 

 

참고 유의사항

 

* [홈페이지] Open API 활용 신청 후, 활용신청 현황의 End Point으로는 전체 서비스 URL을 확인할 수 없습니다.

 

 

* 요청변수(Request Parameter) 입력을 위한 샘플코드 확인시 샘플코드는 PC에서만 확인 가능하며, 화면 크기에 따라 보이지 않을 수 있으니 화면을 최대화하여야 합니다.

 

 

 

전체 코드

# 1. 한국국제협력단_KOICA-ODA 사업정보_KF-공공외교 사업 정보

import requests

import pandas as pd

from google.colab import files

# API 요청 URL 및 기본 파라미터 설정

url = 'http://apis.data.go.kr/B260003/OdaBusinessInfoService/getOdaBusinessInfoList'

# 아래 serviceKey에는 요청해서 부여 받은 "일반 인증키(Decoding)"로 대체하여 기입하셔야 합니다!

service_key = '일반 인증키(Decoding)'

# 데이터 수집 함수

def fetch_all_data(url, service_key):

all_data = []

page_no = 1

while True:

params = {

'serviceKey': service_key,

'numOfRows': '1000', # 한 번에 최대한 많은 데이터를 요청

'pageNo': page_no

}

response = requests.get(url, params=params)

if response.status_code == 200:

items = response.json().get('data', [])

if not items:

break

all_data.extend(items)

page_no += 1

else:

print(f"API 요청 실패: {response.status_code}")

break

return all_data

# 전체 데이터 호출

all_items = fetch_all_data(url, service_key)

# 항목명(영문)과 항목명(국문)의 매핑

column_mapping = {

"country_nm": "한글 국가명",

"country_eng_nm": "영문 국가명",

"country_iso_alp2": "ISO 2자리코드",

"continent_nm": "대륙명",

"business_type_cd": "사업유형코드",

"business_type_cd_nm": "사업유형명",

"kor_business_nm": "사업명(국문)",

"eng_business_nm": "사업명(영문)",

"business_start_dt": "사업시작일",

"business_end_dt": "사업종료일",

"multi_year_type_cd": "다년구분코드",

"multi_year_type_cd_nm": "다년구분코드명",

"bnft_org_nm": "수혜기관명",

"business_year": "사업년도"

}

# 데이터프레임 변환 및 엑셀 파일 저장

if all_items:

df = pd.DataFrame(all_items)

df.rename(columns=column_mapping, inplace=True)

file_path = 'KOICA_odabizinfo_kor.xlsx'

df.to_excel(file_path, index=False)

print(f"전체 데이터가 '{file_path}' 파일로 저장되었습니다.")

files.download(file_path)

else:

print("응답 데이터에 항목이 없습니다.")