Open API 소개
1. 지역어 어휘 정보 오픈 API 서비스 소개
지역어 오픈 API는 색 플랫폼을 외부에 공개하여 다양하고 재미있는 서비스 및 애플리케이션을 개발할 수 있도록 외부 개발자와 사용자들이 공유하는 프로그램입니다.
지역어에 구축된 양질의 사전 정보를 개인 또는 기관에서 오픈 API를 이용해 자유롭게 이용할 수 있도록 제공합니다.
※ 오픈 API란?
하나의 웹 사이트에서 자신이 가진 기능을 이용할 수 있도록 공개한 프로그래밍 인터페이스를 오픈 API라고 합니다.
2. 지역어 어휘 정보 오픈 API 서비스 인증키 발급
오픈 API 서비스를 이용하기 위해서는 먼저 인증키를 발급받아야 합니다. 인증키가 올바르지 않은 경우에는 서비스 이용이 제한됩니다.
인증키가 유효하지 않거나 인증키를 분실한 경우에는 인증키를 재발급받아야 합니다.
3. 지역어 어휘 정보 오픈 API 서비스 이용 안내
연계 표준 서비스를 이용하기 위한 JSON 기반의 데이터 형식, 갱신 데이터 요청 변수, 반환되는 코드값을 제공합니다.
4. 검색 요청 변수(Request Parameters)
오픈 API 요청 URL : https://dialect.korean.go.kr/dialect/openAPI/data
| 요청 변수 | 타입 | 설명 | 필수/선택 |
|---|---|---|---|
| apiKey | String | 키 값 | 필수(apiKey) |
| search_input search_input2 search_input3 |
String | 찾을 대상 (검색어) | 필수(search_input) |
| sel_lang sel_lang2 sel_lang3 |
String | all : 전체 std : 대응 표준어 dlt : 지역어 |
필수(sel_lang) |
| sel_char sel_char2 sel_char3 |
String | contains : 포함 match : 일치 startsWith : 시작문자 endsWith : 끝문자 |
필수(sel_char) |
| sel_andor2 sel_andor3 |
String | in : 그리고 notin : 제외 |
선택 |
| sidoCd sidoCd2 sidoCd3 |
String | 42 : 강원도 41 : 경기도 48 : 경상남도 47 : 경상북도 51 : 광주광역시 52 : 대전 광역시 53 : 울산 광역시 54 : 인천 광역시 46 : 전라남도 45 : 전라북도 50 : 제주특별자치도 44 : 충청남도 43 : 충청북도 |
선택 |
| sigunguNm | String | 시/군/구 | 선택 |
| startYear | String | 조사 시작 연도 | 선택 |
| endYear | String | 조사 완료 연도 | 선택 |
| age | String | 제보자 나이 (구분자 ,) | 선택 |
5. 검색 출력 결과 필드(Response field)
| Field | Type | Description |
|---|---|---|
| BASIS_YEAR | String | 조사 연도 |
| MEAN | String | 의미(뜻풀이) |
| ITEM_NM | String | 항목번호 |
| SIGUNGU_NM | String | 조사지역(시군구) |
| SIDO_CD | String | 조사지역(코드) 42 : 강원도 41 : 경기도 48 : 경상남도 47 : 경상북도 51 : 광주광역시 52 : 대전 광역시 53 : 울산 광역시 54 : 인천 광역시 46 : 전라남도 45 : 전라북도 50 : 제주특별자치도 44 : 충청남도 43 : 충청북도 |
| SIDO_NM | String | 조사지역(시도) |
| SEX | String | 성별(남자 : 1, 여자 : 0) |
| WORD_CLASS | String | 품사 |
| DLT_TP | String | 표제어(지역어) |
| SOURCE | String | 출처 |
| STD_TP | String | 대응 표준어 |
| REL_DLT | String | 다른 지역에서 이르는 말 |
| ADD_MEAN | String | 기타정보 |
| AGE | String | 조사자 나이 |
6. 요청 값(Response Result)
| Key | Description | Data Type |
|---|---|---|
| returnCode | Integer | 검색 오류 코드 (양수인 경우 정상, 음수인 경우 오류) 정상 : 1 네트워크 오류 : 60000 키 오류 : 60002 연결 실패 : 60003 타임아웃 : 60004 Request Timeout : 70002 검색 API 오류 : 나머지 음수 값 |
| totalSize | Integer | 검색 결과 총 건수 |
| resultlist | ArrayList | 검색 결과 목록 |
