개발 지원(Open API)
1. 온용어 오픈 에이피아이 서비스 소개
국립국어원에서는 온용어의 오픈 에이피아이 서비스를 제공합니다.
온용어 오픈 에이피아이는 온용어의 용어 정보를 편리하게 활용할 수 있도록 외부에 공개하는 인터페이스입니다. 이를 활용하여 다양한 애플리케이션, 서비스 등을 개발할 수 있습니다.
온용어 오픈 에이피아이는 온용어의 용어 정보를 편리하게 활용할 수 있도록 외부에 공개하는 인터페이스입니다. 이를 활용하여 다양한 애플리케이션, 서비스 등을 개발할 수 있습니다.
2. 온용어 오픈 에이피아이 서비스 이용 방법
오픈 에이피아이 서비스를 이용하기 위해서는 먼저 회원 가입을 하고, 인증키를 신청하여 발급을 받아야 합니다.
3. 온용어 오픈 에이피아이 서비스의 정보
온용어 오픈 에이피아이 서비스는 문자열 검색 형태의 서비스로 제이슨(JSON) 기반의 데이터로 제공됩니다.
-
오픈 에이피아이 요청 주소
https://kli.korean.go.kr/term/api/search.do검색 요청 변수(Request Parameters)
요청 변수 타입 허용값 필수/선택 설명 key string 16진수 32자리 필수 인증키 apiSearchWord string - 필수 검색어(UTF-8 인코딩)
start integer 1~1000 선택 검색의 시작 번호(기본값 1) / python으로 접근 시 타입(String) num integer 10~100 선택 결과 출력 건수(기본값 10) / python으로 접근 시 타입(String) sort string wt
ka
cnt
new
선택 - 정렬 방식(기본값 wt)
wt: 정확도순
ka: 가나다순
cnt: 인기순
new: 최근순
검색 출력 결과 필드(Response Field)
필드 타입 필수/선택 설명 channel - 필수 결과를 포함하는 컨테이너 total integer 필수 검색된 전체 어휘 개수 returnCode integer 필수 검색 결과 코드 start integer 필수 검색 결과 시작 번호 num integer 필수 검색 결과로 제공하는 어휘 개수 sort string 필수 정렬 방식 word string 필수 용어명 category_main string 선택 국가과학기술표준분류에 의한 대분류 category_sub string 선택 국가과학기술표준분류에 의한 중분류 origin string 선택 원어 origin_cc string 선택 원어의 국가 definition string 선택 정의문 source string 필수 출처 glossary string 필수 용어집 이름 rate string 선택 완비율 kr_gvrn_lcns_ty integer 선택 공공누리 유형 translation string 선택 대역어 translation_cc string 선택 대역어의 국가 relate_word string 선택 관련 용어명 use_ex string 선택 사용 예시 검색 결과(Return Code)
코드 메시지 설명 1 정상 000 System Error 시스템 에러 020 Unregistered Authentication Key 등록되지 않은 키 021 Unavailable Authentication Key 사용할 수 없는 인증키 022 Daily Limit Excess 일일 제한 초과 요청 100 Incorrect Request 부적절하거나 틀린 요청 검색 출력 메시지 예시
검색 결과 출력 예시 오류 출력 예시 {
"channel": {
"total": 1,
"return_object": [
{
"returnCode" : 1,
"resultlist" : [
{
"word" : "학술^용어"
"category_main" : "인문학"
"category_sub" : "언어학"
"origin" : "學術用語"
"origin_cc" : "한자"
"definition" : "특정한 학문 분야에서 소통이 될 수 있도록 사용 범위 및 의미가 전문화되고 체계화된 언어."
"source" : "국립국어원"
"glossary" : "우리말샘"
"rate" : "1"
"kr_gvrn_lcns_ty" : "1"
"translation" : ""
"translation_cc" : ""
"relate_word" : ""
"use_ex" : "산의 높이는 낮고 분화구의 크기가 큰 것은 화산이 분출할 당시에 가스만 터져 나오고 화산재 같은 물질들은 나오지 않았기 때문인데 <strong>학술 용어로</strong> 이러한 화산을 ‘마르(Maar)’라고 한다."
}
]
}
]
}
}
{
"channel": {
"total": 0,
"return_object": [
{
"returnCode": 020,
"message": "Unregistered Authentication Key"
}
]
}
}