참여소통
home참여소통개방공간OpenAPI지방교육재정의 쓰임새를 쉽고 편리하게 파악할 수 있는 지방교육재정알리미
참여·소통
API 이용안내
1. OPEN API 이용안내
지방교육재정알리미 OPEN API는 17개 시·도교육청의 재정 정보를 쉽게 이용할 수 있도록 개방 형태로 제공합니다.
2. OPEN API 이용절차
STEP01
SNS 로그인
STEP02
인증키 발급
STEP03
OPEN API
지방교육재정알리미 로그인
SNS 계정으로 회원가입을 통해 OPEN API 서비스를 이용할 수 있습니다.
인증키 신청(최초 1회만 신청) 및 확인
OPEN API를 사용하기 위해서는 인증키를 발급받아야 합니다.
인증키를 발급받기 위해 서비스구분(앱/웹, URL), 사용자 정보(유형, 목적), 활용용도, 간략 설명을 입력해야 합니다.
인증키 목록
발급된 인증키는 로그인 후 참여소통 → 개방공간 → 마이페이지 → 인증키 목록에서 확인할 수 있습니다.
입력인자 및 호출
OPEN API 호출을 위해서는 요청주소 및 요청인자를 파악해야 합니다.
해당 정보는 서비스별 OPEN API 메타 정보 화면에서 확인이 가능합니다.
호출 URL은 기본적으로 다음과 같은 항목으로 구성되어 있으며, GET방식으로 호출합니다.
(브라우저에서 호출 URL을 입력하시면 쉽게 확인이 가능합니다.)
http://요청주소?requestType=호출서비스명&key=인증키&type=요청파일타입&plndex=페이지위치&pSize=요청숫자
① 요청주소 : OPEN API 서비스에서 요청주소를 확인합니다.
② 호출서비스명 : 각 OPEN API 별로 고유한 영문 서비스명을 제공합니다.(요청인자 3번째 항목)
③ 인증키 : 신청한 인증키를 입력합니다.(sample 키는 최초 5건 이내에서만 호출 가능, 정식 서비스를 위해서는 인증키 발급 필수)
④ 요청파일타입 : OPEN API 호출 결과물의 파일 형태를 지정합니다.(xml, json 중 택1)
⑤ 페이지위치 : 호출하고자 하는 데이터 목록의 시작위치를 입력합니다.
⑥ 요청숫자 : 호출하고자 하는 데이터의 수를 입력합니다.
※ 필수 검색어(요청주소, 호출서비스명, 인증키)는 반드시 입력해야 정상 호출됩니다.
※ 선택 검색어(요청파일타입, 페이지위치, 요청숫자)는 미입력 시 기본값으로 호출됩니다.
출력값 및 에러 메시지 확인
출력값(Out Result) : 출력 컬럼 확인
3. OPEN API 사용 제한
상업적 이용이 불가능한 API를 상업적으로 활용하는 경우
트래픽 초과로 인한 시스템의 부하가 발생하는 경우
공공의 목적이 아닌 기타 개인의 목적이나 불법적인 목적으로 API를 활용하는 경우
