Open API
1. Introducing the K-term Open API Service
The National Institute of the Korean Language provides an open API service for K-term words. K-term Open API is an interface that allows convenient use of on-term terminology information to be disclosed externally. Various applications and services can be developed using this.
2. How to use the K-term Open API service
To use the Open API service, you must first register as a member and apply for and receive an authentication key.
3. Information on K-term Open API Service
The K-term Open API service is provided as a string search service with JSON-based data.
-
오픈 에이피아이 요청 주소(Open API Request URL)
https://kli.korean.go.kr/term/api/search.do검색 요청 변수(Request Parameters)
Request Variables Type Tolerance Required/Optional Explanation key string 32 hexadecimal digits Required Authentication key apiSearchWord string - Required Search term(UTF-8 Encoding)
start integer 1~1000 Optional Start number of search(Default 1) / Python Type(String) num integer 10~100 Optional Number of results output(Default 10) / Python Type(String) sort string wt
ka
cnt
new
Optional - Sorting(Default wt)
wt: By accuracy
ka: Alphabetic order
cnt: By hit
new: Most recent
검색 출력 결과 필드(Response Field)
Field Type Required/Optional Explanation channel - Required Container containing the results total integer Required Total number of words searched returnCode integer Required Search Results Code start integer Required Search start number num integer Required Number of words provided in search results sort string Required Sorting word string Required Term name category_main string Optional Major class according to the National Science and Technology Standards Classification category_sub string Optional Middle class according to the National Science and Technology Standard Classification origin string Optional OL origin_cc string Optional Regions where the original language is used definition string Optional Definition source string Required Source glossary string Required Glossary Name rate string Optional Completion Rate kr_gvrn_lcns_ty integer Optional KOGL Type translation string Optional Translation translation_cc string Optional Regions where the translation is originally used relate_word string Optional Related Term use_ex string Optional Usage Example 검색 결과(Return Code)
Code Message Explanation 1 Success 000 System Error System Error 020 Unregistered Authentication Key Unregistered key 021 Unavailable Authentication Key Unavailable authentication key 022 Daily Limit Excess Request to exceed daily limit 100 Incorrect Request Inappropriate or incorrect request 검색 출력 메시지 예시(Example of API response)
Success Error {
"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"
}
]
}
}