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 | 키 값 | 필수 |
| searchWord | String | 검색어 | 필수 |
| sidoCd | String |
조사지역 대분류(시/도) 코드 41 : 경기도 42 : 강원도 43 : 충청북도 44 : 충청남도 45 : 전라북도 46 : 전라남도 47 : 경상북도 48 : 경상남도 50 : 제주특별자치도 51 : 광주광역시 52 : 대전광역시 53 : 울산광역시 54 : 인천광역시 |
선택 |
| sigunguNm | String | 조사지역 소분류(시/군/구) 이름 | 선택 |
| startYear | String | 조사 시작 연도 | 선택 |
| endYear | String | 조사 완료 연도 | 선택 |
| age | String | 제보자 연령대(10대 단위) | 선택 |
| sex | String |
제보자 성별 0 : 여성 1: 남성 |
선택 |
5. 검색 출력 결과 필드(Response field)
| Field | Type | Description |
|---|---|---|
| dialectId | Integer | 단어 일련번호 |
| dltTp | String | 지역어 |
| stdTp | String | 대응 표준어 |
| sidoCd | String |
조사지역 대분류(시/도) 코드 41 : 경기도 42 : 강원도 43 : 충청북도 44 : 충청남도 45 : 전라북도 46 : 전라남도 47 : 경상북도 48 : 경상남도 50 : 제주특별자치도 51 : 광주광역시 52 : 대전광역시 53 : 울산광역시 54 : 인천광역시 |
| sigunguNm | String | 조사지역 소분류(시/군/구) 이름 |
| source | String | 출처 |
| basisYear | Integer | 조사 연도 |
| Integer | String | 제보자 연령 |
| sex | String |
제보자 성별 0 : 여성 1 : 남성 |
6. 요청 값(Response Result)
| Key | Description | Data Type |
|---|---|---|
| returnCode | Integer |
상태 코드 60000 : 정상 60002 : 유효하지 않은 API 키 값 |
| totalCount | Integer | 검색 결과 수 |
| resultList | ArrayList | 검색 결과 목록 |
