이 누리집은 대한민국 공식 전자정부 누리집입니다.
- مقدمة عن واجهة البرمجة المفتوحة (Open API)
- طلب استخدام واجهة برمجة التطبيقات المفتوحة
- مثال خدمة واجهة برمجة التطبيقات المفتوحة
1. مقدمة عن خدمة واجهة البرمجة المفتوحة (Open API) لمعجم اللغة الكورية الأساسي
ما هي واجهة البرمجة المفتوحة (Open API)؟
تُسمّى واجهة البرمجة المفتوحة (Open API) الواجهة البرمجية التي يفتحها أحد مواقع الويب لتمكين استخدام الوظائف التي يملكها.2. إصدار مفتاح التوثيق لخدمة واجهة البرمجة المفتوحة (Open API) لمعجم اللغة الكورية الأساسي
3. إرشادات استخدام خدمة واجهة البرمجة المفتوحة (Open API) لمعجم اللغة الكورية الأساسي
- واجهة برمجة التطبيقات المفتوحة (Open API) للبحث في المعجم
- واجهة البرمجة المفتوحة (Open API) لمحتوى المعجم
عنوان URL لواجهة البرمجة المفتوحة (Open API)
معاملات طلب البحث (Request Parameters)
| معاملات طلب | النوع | القيم المسموح بها | إلزامي/اختياري | الوصف |
|---|---|---|---|---|
| key | string | 32 خانة بنظام العد الست عشري | إلزامي | مفتاح التوثيق |
| q | string | - | إلزامي | كلمة البحث (UTF-8 Encoding) |
| start | integer | 1~1000 | اختياري | رقم بداية البحث (القيمة الافتراضية 1) |
| num | integer | 10~100 | اختياري | عدد نتائج البحث المعروضة (القيمة الافتراضية 10) |
| sort | string | dict popular |
اختياري | طريقة الترتيب (القيمة الافتراضية dict) dict: 사전 순 popular: 많이 찾은 순 |
| part | string | word ip dfn exam |
اختياري | البحث المستهدف (القيمة الافتراضية word) word: 어휘 ip: 관용구, 속담 dfn: 뜻풀이 exam: 용례 |
| translated | string | n y |
اختياري | خيار الترجمة متعددة اللغات (القيمة الافتراضية -n) في حال كانت القيمة y، يتم تطبيق معامل لغة الترجمة. |
| trans_lang | string | 0-11 | اختياري | * يمكن ضبط معامل طلب 'translated (الترجمة متعددة اللغات)' في حال كانت قيمته 'y'. لغة الترجمة (القيمة الافتراضية 0 - جميع لغات الترجمة) تُعدّد القيم التالية مفصولة بفاصلة (,) للسماح بالاختيار المتعدد. 전체(0), 영어(1), 일본어(2), 프랑스어(3), 스페인어(4), 아랍어(5), 몽골어(6), 베트남어(7), 타이어(8), 인도네시아어(9), 러시아어(10), 중국어(11) |
| advanced | string | n y |
اختياري | خيار البحث المفصل (القيمة الافتراضية -n) في حال كانت القيمة y، يتم تطبيق معامل لغة الترجمة. |
※ لاستخدام معاملات الطلب الواردة في الأسفل، يجب ضبط معامل الطلب "advanced" إلى القيمة 'y' في خيار البحث المفصل (القيمة الافتراضية n). |
||||
| target | integer | 1~10 | اختياري |
العنصر المستهدف (القيمة الافتراضية 1 - الكلمة الرئيسية)
어휘(표제어)(1), 뜻풀이(2), 용례(3), 원어(4), 발음(5), 활용(6), 활용의 준말(7), 관용구(8), 속담(9), 참고 정보(10) |
| lang | integer | 0~49 | اختياري |
※ في حال كانت قيمة معامل الطلب 'target (العنصر المستهدف)' هي 'الكلمة الأصلية (4)'، يمكن ضبط معامل الطلب 'lang (اللغة)'.
اللغة (القيمة الافتراضية 0 - الكل) 전체(0), 고유어(1), 한자(2), 안 밝힘(3), 영어(4), 그리스어(5), 네덜란드어(6), 노르웨어어(7), 독일어(8), 라틴어(9), 러시아어(10), 루마니아어(11), 마오리어(12), 말레이어(13), 몽골어(14), 바스크어(15), 버마어(16), 베트남어(17), 불가리어어(18), 산스크리트어(19), 세르보ᆞ크로아트어(20), 스와힐리어(21), 스웨덴어(22), 아랍어(23), 아일랜드어(24), 에스파냐어(25), 우즈베크어(26), 우크라이나어(27), 이탈리아어(28), 인도네시아어(29), 일본어(30), 중국어(31), 체코어(32), 캄보디아어(33), 케추아어(34), 타갈로그어(35), 타이어(36), 터키어(37), 티베트어(38), 페르시아어(39), 포르투갈어(40), 폴란드어(41), 프랑스어(42), 프로방스어(43), 핀란드어(44), 헝가리어(45), 히브리어(46), 힌디어(47), 기타어(48), 덴마크어(49) |
| method | string |
exact
include start end |
اختياري |
طريقة البحث (القيمة الافتراضية exact)
exact: 일치 검색 include: 포함 검색 start: 시작 end: 끝 |
| type1 | array of string |
all
word phrase expression |
اختياري |
التصنيف 1 (القيمة الافتراضية all)
تُعدّد القيم الآتية مفصولة بفاصلة (,) للسماح بالاختيار المتعدد. word: 단어 phrase: 구 expression: 문법 표현 |
| type2 | array of string |
all
native chinese loanword hybrid |
اختياري |
التصنيف 2 (القيمة الافتراضية all)
تُعدّد القيم الآتية مفصولة بفاصلة (,) للسماح بالاختيار المتعدد. native: 고유어 chinese: 한자어 loanword: 외래어 hybrid: 혼종어 |
| level | array of string |
all
level1 level2 level3 |
اختياري |
المفردات حسب المستوى (القيمة الافتراضية all)
تُعدّد القيم الآتية مفصولة بفاصلة (,) للسماح بالاختيار المتعدد. level1: 초급 level2: 중급 level3: 고급 |
| pos | array of integer | 0 ~ 15 | اختياري |
أجزاء الكلام (القيمة الافتراضية 0 - جميع أجزاء الكلام)
تُعدّد القيم الآتية مفصولة بفاصلة (,) للسماح بالاختيار المتعدد. 전체(0), 명사(1), 대명사(2), 수사(3), 조사(4), 동사(5), 형용사(6), 관형사(7), 부사(8), 감탄사(9), 접사(10), 의존 명사(11), 보조 동사(12), 보조 형용사(13), 어미(14), 품사 없음(15) |
| multimedia | array of integer | 0 ~ 6 | اختياري |
معلومات وسائط متعددة (القيمة الافتراضية 0 - الكل)
تُعدّد القيم الآتية مفصولة بفاصلة (,) للسماح بالاختيار المتعدد. 전체(0), 사진(1), 삽화(2), 동영상(3), 애니메이션(4), 소리(5), 없음(6) |
| letter_s | integer | 1 ~ | اختياري | بداية عدد المقاطع (القيمة الافتراضية 1) |
| letter_e | integer | 0 ~ | اختياري |
نهاية عدد المقاطع (القيمة الافتراضية 0)
القيمة الافتراضية 0 تعني جميع أعداد المقاطع |
| sense_cat | array of integer | 0 ~ 153 | اختياري |
الفئة الدلالية (القيمة الافتراضية 0 - الكل)
전체(0), 인간 > 전체(1), 인간 > 사람의 종류(2), 인간 > 신체 부위(3), 인간 > 체력 상태(4), 인간 > 생리 현상(5), 인간 > 감각(6), 인간 > 감정(7), 인간 > 성격(8), 인간 > 태도(9), 인간 > 용모(10), 인간 > 능력(11), 인간 > 신체 변화(12), 인간 > 신체 행위(13), 인간 > 신체에 가하는 행위(14), 인간 > 인지 행위(15), 인간 > 소리(16), 인간 > 신체 내부 구성(17), 삶 > 전체(18), 삶 > 삶의 상태(19), 삶 > 삶의 행위(20), 삶 > 일상 행위(21), 삶 > 친족 관계(22), 삶 > 가족 행사(23), 삶 > 여가 도구(24), 삶 > 여가 시설(25), 삶 > 여가 활동(26), 삶 > 병과 증상(27), 삶 > 치료 행위(28), 삶 > 치료 시설(29), 삶 > 약품류(30), 식생활 > 전체(31), 식생활 > 음식(32), 식생활 > 채소(33), 식생활 > 곡류(34), 식생활 > 과일(35), 식생활 > 음료(36), 식생활 > 식재료(37), 식생활 > 조리 도구(38), 식생활 > 식생활 관련 장소(39), 식생활 > 맛(40), 식생활 > 식사 및 조리 행위(41), 의생활 > 전체(42), 의생활 > 옷 종류(43), 의생활 > 옷감(44), 의생활 > 옷의 부분(45), 의생활 > 모자, 신발, 장신구(46), 의생활 > 의생활 관련 장소(47), 의생활 > 의복 착용 상태(48), 의생활 > 의복 착용 행위(49), 의생활 > 미용 행위(50), 주생활 > 전체(51), 주생활 > 건물 종류(52), 주생활 > 주거 형태(53), 주생활 > 주거 지역(54), 주생활 > 생활 용품(55), 주생활 > 주택 구성(56), 주생활 > 주거 상태(57), 주생활 > 주거 행위(58), 주생활 > 가사 행위(59), 사회 생활 > 전체(60), 사회 생활 > 인간관계(61), 사회 생활 > 소통 수단(62), 사회 생활 > 교통 수단(63), 사회 생활 > 교통 이용 장소(64), 사회 생활 > 매체(65), 사회 생활 > 직장(66), 사회 생활 > 직위(67), 사회 생활 > 직업(68), 사회 생활 > 사회 행사(69), 사회 생활 > 사회 생활 상태(70), 사회 생활 > 사회 활동(71), 사회 생활 > 교통 이용 행위(72), 사회 생활 > 직장 생활(73), 사회 생활 > 언어 행위(74), 사회 생활 > 통신 행위(75), 사회 생활 > 말(76), 경제 생활 > 전체(77), 경제 생활 > 경제 행위 주체(78), 경제 생활 > 경제 행위 장소(79), 경제 생활 > 경제 수단(80), 경제 생활 > 경제 산물(81), 경제 생활 > 경제 상태(82), 경제 생활 > 경제 행위(83), 교육 > 전체(84), 교육 > 교수 학습 주체(85), 교육 > 전공과 교과목(86), 교육 > 교육 기관(87), 교육 > 학교 시설(88), 교육 > 학습 관련 사물(89), 교육 > 학문 용어(90), 교육 > 교수 학습 행위(91), 교육 > 학문 행위(92), 종교 > 전체(93), 종교 > 종교 유형(94), 종교 > 종교 활동 장소(95), 종교 > 종교인(96), 종교 > 종교어(97), 종교 > 신앙 대상(98), 종교 > 종교 활동 도구(99), 종교 > 종교 행위(100), 문화 > 전체(101), 문화 > 문화 활동 주체(102), 문화 > 음악(103), 문화 > 미술(104), 문화 > 문학(105), 문화 > 예술(106), 문화 > 대중 문화(107), 문화 > 전통 문화(108), 문화 > 문화 생활 장소(109), 문화 > 문화 활동(110), 정치와 행정 > 전체(111), 정치와 행정 > 공공 기관(112), 정치와 행정 > 사법 및 치안 주체(113), 정치와 행정 > 무기(114), 정치와 행정 > 정치 및 치안 상태(115), 정치와 행정 > 정치 및 행정 행위(116), 정치와 행정 > 사법 및 치안 행위(117), 정치와 행정 > 정치 및 행정 주체(118), 자연 > 전체(119), 자연 > 지형(120), 자연 > 지표면 사물(121), 자연 > 천체(122), 자연 > 자원(123), 자연 > 재해(124), 자연 > 기상 및 기후(125), 동식물 > 전체(126), 동식물 > 동물류(127), 동식물 > 곤충류(128), 동식물 > 식물류(129), 동식물 > 동물의 부분(130), 동식물 > 식물의 부분(131), 동식물 > 동식물 행위(132), 동식물 > 동물 소리(133), 개념 > 전체(134), 개념 > 모양(135), 개념 > 성질(136), 개념 > 속도(137), 개념 > 밝기(138), 개념 > 온도(139), 개념 > 색깔(140), 개념 > 수(141), 개념 > 세는 말(142), 개념 > 양(143), 개념 > 정도(144), 개념 > 순서(145), 개념 > 빈도(146), 개념 > 시간(147), 개념 > 위치 및 방향(148), 개념 > 지역(149), 개념 > 지시(150), 개념 > 접속(151), 개념 > 의문(152), 개념 > 인칭(153) |
| subject_cat | array of integer | 0 ~ 106 | اختياري |
فئة الموضوع والحالة (القيمة الافتراضية 0 - الكل)
تُعدّد القيم الآتية مفصولة بفاصلة (,) للسماح بالاختيار المتعدد. 전체(0), 인사하기(1), 소개하기(자기소개)(2), 소개하기(가족소개)(3), 개인 정보 교환하기(4), 위치 표현하기(5), 길찾기(6), 교통 이용하기(7), 물건 사기(8), 음식 주문하기(9), 요리 설명하기(10), 시간 표현하기(11), 날짜 표현하기(12), 요일 표현하기(13), 날씨와 계절(14), 하루 생활(15), 학교생활(16), 한국 생활(17), 약속하기(18), 전화하기(19), 감사하기(20), 사과하기(21), 여행(22), 주말 및 휴가(23), 취미(24), 가족 행사(25), 건강(26), 병원 이용하기(27), 약국 이용하기(28), 공공 기관 이용하기(도서관)(29), 공공 기관 이용하기(우체국)(30), 공공 기관 이용하기(출입국 관리 사무소)(31), 초대와 방문(32), 집 구하기(33), 집안일(34), 감정, 기분 표현하기(35), 성격 표현하기(36), 복장 표현하기(37), 외모 표현하기(38), 영화 보기(39), 개인 정보 교환하기(40), 교통 이용하기(41), 지리 정보(42), 물건 사기(43), 음식 설명하기(44), 요리 설명하기(45), 날씨와 계절(46), 학교생활(47), 한국 생활(48), 직업과 진로(49), 직장 생활(50), 여행(51), 주말 및 휴가(52), 취미(53), 가족 행사(54), 가족 행사(명절)(55), 건강(56), 공공기관 이용하기(57), 초대와 방문(58), 집 구하기(59), 집안일(60), 감정, 기분 표현하기(61), 성격 표현하기(62), 복장 표현하기(63), 외모 표현하기(64), 공연과 감상(65), 대중 매체(66), 컴퓨터와 인터넷(67), 사건, 사고, 재해 기술하기(68), 환경 문제(69), 문화 비교하기(70) , 인간관계(71), 한국의 문학(72), 문제 해결하기(분실 및 고장)(73), 실수담 말하기(74), 연애와 결혼(75), 언어(76), 지리 정보(77), 경제∙경영(78), 식문화(79), 기후(80), 교육(81), 직업과 진로(82), 직장 생활(83), 여가 생활(84), 보건과 의료(85), 주거 생활(86), 심리(87), 외양(88), 대중문화(89), 컴퓨터와 인터넷(90), 사회 문제(91), 환경 문제(92), 사회 제도(93), 문화 차이(94), 인간관계(95), 예술(96), 건축(97), 과학과 기술(98), 법(99), 스포츠(100), 언론(101), 언어(102), 역사(103), 정치(104), 종교(105), 철학∙윤리(106) |
حقل مخرجات البحث (Response field): بصيغة XML (مشترك)
| حقل | النوع | إلزامي/اختياري | الوصف |
|---|---|---|---|
| channel | - | إلزامي | حاوية تحتوي على النتائج |
| title | string | إلزامي | عنوان واجهة البرمجة المفتوحة (Open API) للبحث في معجم اللغة الكورية الأساسي (القيمة الثابتة) واجهة البرمجة المفتوحة (Open API) لمعجم اللغة الكورية الأساسي - البحث في المعجم |
| link | string | إلزامي | عنوان URL لمعجم اللغة الكورية الأساسي (القيمة الثابتة) https://krdict.korean.go.kr |
| description | string | إلزامي | وصف خدمة واجهة البرمجة المفتوحة (Open API) (القيمة الثابتة) واجهة البرمجة المفتوحة (Open API) لمعجم اللغة الكورية الأساسي – نتائج البحث في المعجم |
| lastBuildDate | datetime | إلزامي | وقت إنتاج نتائج البحث |
| total | integer | إلزامي | إجمالي عدد المفردات المسترجعة بالبحث |
| start | integer | إلزامي | رقم بداية نتائج البحث |
| num | integer | إلزامي | عدد المفردات المقدمة كنتائج للبحث |
حقل مخرجات البحث (Response field): بصيغة XML (المفردات، التعابير الاصطلاحية، الأمثال، الشروح كنتائج للإخراج)
| حقل | النوع | إلزامي/اختياري | الوصف |
|---|---|---|---|
| item | - | إلزامي | حاوية تحتوي على نتائج البحث الفردية. تتكرر بعدد 'num' |
| target_code | integer | إلزامي | رمز التعريف |
| word | string | إلزامي | الكلمة الرئيسية |
| sup_no | integer | إلزامي | رقم الكلمة المتجانسة |
| origin | string | اختياري | الكلمة الأصلية |
| pronunciation | string | اختياري | النطق |
| word_grade | string | اختياري | مستوى المفردات |
| pos | string | إلزامي | أجزاء الكلام |
| link | string | إلزامي | عنوان URL لعرض محتوى المعجم |
| sense | string | إلزامي | حاوية تحتوي على معنى فردي |
| sense_order | integer | إلزامي | الرقم التسلسلي للمعنى الفردي |
| definition | string | إلزامي | الشرح |
| translation | string | اختياري | حاوية تحتوي على معنى فردي (العنصر element الفرعي لـ sense) |
| trans_word | string | اختياري | ترجمة الكلمة الرئيسية |
| trans_dfn | string | اختياري | ترجمة الشرح |
حقل مخرجات البحث (Response field): بصيغة XML (نتائج إخراج أمثلة الاستخدام)
| حقل | النوع | إلزامي/اختياري | الوصف |
|---|---|---|---|
| item | - | إلزامي | حاوية تحتوي على نتائج البحث الفردية. تتكرر بعدد 'num' |
| target_code | integer | إلزامي | رمز التعريف |
| word | string | إلزامي | الكلمة الرئيسية |
| sup_no | integer | إلزامي | رقم الكلمة المتجانسة |
| example | string | إلزامي | أمثلة الاستخدام |
| link | string | إلزامي | عنوان URL لعرض محتوى المعجم |
رسالة خطأ البحث (error message)
| رمز الخطأ | رسالة الخطأ | الوصف |
|---|---|---|
| 000 | System error | خطأ في النظام |
| 010 | Daily API Limit Exceeded | تجاوز الحد المسموح به من استدعاءات الـ API في اليوم (50000 مرة) |
| 020 | Unregistered key | مفتاح التوثيق غير المسجل |
| 021 | Your key is temporary unavailable | مفتاح التوثيق الموقوف عن الاستخدام مؤقتًا |
| 100 | Incorrect query request | طلب استعلام غير مناسب. يحدث هذا الخطأ في حال عدم وجود حقل query نفسه. |
| 101 | Invalid target value | حقل بحث غير مناسب |
| 102 | Invalid method value | طريقة بحث غير مناسبة |
| 103 | Invalid num value | عدد بحث غير مناسب |
| 104 | Invalid start value | قيمة start غير مناسبة |
| 105 | Invalid sort value | ترتيب فرز غير مناسب |
| 106 | Invalid part value | قيمة عنصر مستهدف للبحث غير مناسبة |
| 107 | Invalid translated value | قيمة خيار الترجمة متعددة اللغات غير مناسبة |
| 108 | Invalid trans_lang value | قيمة لغة الترجمة غير مناسبة |
| 109 | Invalid advanced value | خيار البحث المفصل غير مناسب |
| 110 | Invalid lang value | قيمة لغة غير مناسبة |
| 200 | Invalid type1 value | قيمة type1 غير مناسبة |
| 201 | Invalid type2 value | قيمة type2 غير مناسبة |
| 203~209 | - | الحجز |
| 210 | Invalid pos value | أجزاء كلام غير مناسبة |
| 211 | Invalid level value | مفردات حسب المستوى غير مناسبة |
| 212 | Invalid multimedia value | وسائط متعددة غير مناسبة |
| 213 | Invalid sense_cat value | فئة دلالية غير مناسبة |
| 214 | Invalid subject_cat value | فئة الموضوع والحالة غير مناسبة |
| 215 | Invalid letter_s value | بداية عدد المقاطع غير مناسبة |
| 216 | Invalid letter_e value | نهاية عدد المقاطع غير مناسبة |
مثال على مخرجات XML عند بحث المفردات
<?xml version="1.0" encoding="UTF-8" ?>
<channel>
<title>한국어 기초사전 개발 지원(Open API) - 사전 검색</title>
<link>https://krdict.korean.go.kr</link>
<description>한국어 기초사전 개발 지원(Open API) - 사전 검색 결과</description>
<lastBuildDate>2017-11-14 14:12:51</lastBuildDate>
<total>53</total>
<start>1</start>
<num>10</num>
<item>
<target_code>32750</target_code>
<word>나무</word>
<sup_no>0<sup_no>
<pronunciation>나무<pronunciation>
<word_grade>초급<word_grade>
<pos>명사</pos>
<link>https://krdict.korean.go.kr/dicSearch/SearchView?paraWordNo=32750</link>
<sense>
<sense_order>1</sense_order>
<definition>줄기나 가지가 목질로 된 여러해살이 식물.</definition>
<translation>
<trans_lang>영어</trans_lang>
<trans_word>tree</trans_word>
<trans_dfn>A plant with a hard stem, branches and leaves.</trans_dfn>
</translation>
<translation>
<trans_lang>일본어</trans_lang>
<trans_word>き【木・樹】。じゅもく【樹木】</trans_word>
<trans_dfn>しっかりした幹に枝と葉がついた、数年間にわたって育つ植物。</trans_dfn>
</translation>
</sense>
<sense>
<sense_order>2</sense_order>
<definition>집이나 가구 등을 만드는 데 사용하는 재목.</definition>
<translation>
<trans_lang>영어</trans_lang>
<trans_word>wood</trans_word>
<trans_dfn>The material used to build a house or to make furniture.</trans_dfn>
</translation>
<translation>
<trans_lang>일본어</trans_lang>
<trans_word>き【木・樹】。ざいもく【材木】</trans_word>
<trans_dfn>住宅や家具などを作るのに用いる材木。</trans_dfn>
</translation>
</sense>
<sense>
<sense_order>3</sense_order>
<definition>불을 때기 위해 베어 놓은 나무의 줄기나 가지.</definition>
<translation>
<trans_lang>영어</trans_lang>
<trans_word>timber; log</trans_word>
<trans_dfn>The trunk or branches of a tree cut to be used as firewood.</trans_dfn>
</translation>
<translation>
<trans_lang>일본어</trans_lang>
<trans_word>まき・たきぎ【薪】</trans_word>
<trans_dfn>火をたくために切った木の幹や枝。</trans_dfn>
</translation>
</sense>
</item>
<item>
</channel>
مثال على مخرجات XML عند بحث أمثلة الاستخدام
<?xml version="1.0" encoding="UTF-8" ?>
<channel>
<title>한국어 기초사전 개발 지원(Open API) - 사전 검색</title>
<link>https://krdict.korean.go.kr</link>
<description>한국어 기초사전 개발 지원(Open API) - 사전 검색 결과</description>
<lastBuildDate>2017-11-14 14:24:31</lastBuildDate>
<total>2277</total>
<start>1</start>
<num>10</num>
<item>
<target_code>27965</word>
<word>가공성</word>
<sup_no>0</sup_no>
<example>나무가 지나치게 단단하면 변형이 어려워 가공성이 떨어진다. </example>
<link>https://krdict.korean.go.kr/dicSearch/SearchView?ParaWordNo=27965</link>
</item>
<item>
<target_code>28027</word>
<word>가공하다</word>
<sup_no>1</sup_no>
<example>집 앞 공장에서는 나무를 가공하여 여러 가지 가구를 만든다. </example>
<link>https://krdict.korean.go.kr/dicSearch/SearchView?ParaWordNo=28027</link>
</item>
</channel>
مثال على XML لرسالة خطأ في مخرجات البحث
| بنية XML لرسالة الخطأ | مثال على XML لرسالة الخطأ |
|---|---|
|
<?xml version="1.0" encoding="UTF-8" ?>
<error_code>에러코드</error_code> </error> |
<?xml version="1.0" encoding="UTF-8" ?>
<error_code>020</error_code> </error> |
