오픈 API
한식 아카이브에서는 구축된 한식 관련 DB를 개인, 기관이 자유롭게 이용할 수 있도록 검색 OpenAPI를 제공합니다.
검색 OpenAPI의 이용을 위해 사용자 식별 Key를 발급하고 있습니다.
신청양식을 작성하시고 사용자 식별 Key를 인증받으신 후, 아래의 사용 안내에 따라 검색 OpenAPI를 사용하시기 바랍니다.
신청시 입력한 사용목적 이외에 OpenAPI사용을 금하며, 식별Key를 타인에게 양도할 수 없습니다.
OpenAPI는 플랫폼으로서 "웹" 이라는 특징을 기술적으로 구현한 대표적인 Web 2.0 기술입니다.
하나의 웹 사이트에서 사이트가 가진 기능을 이용할 수 있도록 공개한 프로그래밍 인터페이스를 OpenAPI라고 합니다.
검색 오픈 API 사용 키를 신청하려면 로그인을 해야 합니다.
로그인신청 내역을 확인하려면 로그인을 해야 합니다.
로그인검색 영역별로 별도의 URL을 사용하여야 하며, 결과물 출력은 JSON 포맷입니다.
기본 출력변수는 다음과 같습니다.
출력변수 | 값 | 설명 |
---|---|---|
count | integer | 결과물 수 |
next | url | 다음 페이지 url |
previous | url | 이전 페이지 url |
results | array | 검색 결과 배열 |
한식아카이브 분류체계 검색 API
한식콘텐츠 목록을 검색하여 결과를 JSON 포맷으로 전달하는 API 서비스입니다.
검색 영역을 구축 영역별로 제한하여 질의할 수 있습니다.
https://hansik.or.kr/openapi/contents/
https://hansik.or.kr/openApi/contents.do?_format=json&apiKey=API_KEY&titl=질의어&category=분류
요청 변수 | 값 | 설명 |
---|---|---|
titl | string(필수) | 질의어 |
ctgry | string[풍속서류|단행본|...] |
|
curPage | integer | 검색결과 목록 페이지 |
출력변수 | 값 | 설명 |
---|---|---|
menu | string | 분류키 |
menu_verbose | 분류명 | |
titl | 서명 | |
titleEtc | 서명(한글) | |
publisher | 출판사 | |
publishedyear | 출판년도 | |
edition | 판본 | |
description | 간략설명 | |
journal | 저널명 | |
location | 소장처 | |
link | url | 서비스 URL |
북한의 전통음식 검색 API
북한의 전통음식을 검색하여 결과를 JSON 포맷으로 전달하는 API 서비스입니다.
검색 영역을 구축 영역별로 제한하여 질의할 수 있습니다.
https://hansik.or.kr/openapi/nkfood/
https://hansik.or.kr/openApi/nkfood.do?_format=json&apiKey=API_KEY&titl=질의어®ionName=검색결과 목록 페이지
요청 변수 | 값 | 설명 |
---|---|---|
titl | string(필수) | 질의어 |
regionName | string | 지역명.도.단위명 |
curPage | integer | 검색결과 목록 페이지 |
출력변수 | 값 | 설명 |
---|---|---|
regionName | url | 시도 단위명 |
servings | integer | 인분 |
yearOpeningVerbose | array::dictionary{titl, weight} | 요리 재료::재료명과 중량 |
recipeDirections | array::dictionary{sequence, description} | 조리법::순번과 설명 |
link | url | 서비스 URL |
curPage | integer | 검색결과 목록 페이지 |
한식소재스토리텔링 검색 API
한식소재스토리텔링을 검색하여 결과를 JSON 포맷으로 전달하는 API 서비스입니다.
검색 영역을 구축 영역별로 제한하여 질의할 수 있습니다.
https://hansik.or.kr/openapi/story/
https://hansik.or.kr/openApi/story.do?_format=json&apiKey=API_KEY&titl=질의어
요청 변수 | 값 | 설명 |
---|---|---|
titl | string(필수) | 질의어 |
curPage | integer | 검색결과 목록 페이지 |
출력변수 | 값 | 설명 |
---|---|---|
category | string | 분류 |
titl | string | 음식명 |
link | url | 서비스 URL |