오픈API

오픈API 사용가이드

신청하기

오픈API정의

공예포털에서 서비스 하고 있는 자료를 개인 또는 기관에서 오픈 API를 통해 자유롭게 이용할 수 있도록 제공합니다.

오픈API 사용안내

기본적으로 제공 API 서비스를 사용하시기 위하여 '서비스 인증키' 를 개별적으로 발급받으셔야 합니다.

오픈API <URL> 조합 예시

요청URL + 검색조건 값(파라미터) + Service Key (Service Key에 대한 부분은 UTF-8로 URL 인코딩하여 보내야 함)

https://craft.kcdf.kr/openApi/rest/list/bsnsArchive?numOfrows=10&pageNo=1&keyword=%EA%B3%B5%EB%AA%A8&serviceKey={서비스 키}

*자세한 사항은 각 조회서비스별 개발가이드를 참고하시기 바랍니다.

오퍼레이션 목록

오퍼레이션 목록 - 오퍼레이션, 서비스 내용, 전송방식, 요청URL로 구성
오퍼레이션서비스 내용전송방식요청URL
공예공간 목록 조회공예공간정보 목록을
조회한다
RESThttps://craft.kcdf.kr/openApi/rest/list/bsnes
행사-전시 목록 조회행사-전시정보 목록을
조회한다
RESThttps://craft.kcdf.kr/openApi/rest/list/event
사업아카이브 목록 조회사업아카이브 목록을
조회한다
RESThttps://craft.kcdf.kr/openApi/rest/list/bsnsArchive

개발가이드 다운로드

공예포털API 개발가이드

에러메세지

에러메세지 - 번호, 에러메세지로 구성
번호에러메세지
1APPLICATION ERROR (시스템 에러)
11SERVICE_KEY_DOSE_NOT_EXIST_ERROR (인증키 값이 비어 있음)
12SERVICE_KEY_DOSE_NOT_EXIST_ERROR (인증키 값이 유효하지 않음)

오픈API 사용예제

요청서비스

사업아카이브 목록을 조회

요청URL

https://craft.kcdf.kr/openApi/rest/list/bsnsArchive

요청변수

요청변수 - 요청변수, 데이터타입, 필수, 설명으로 구성
요청변수데이터타입필수설명
serviceKeyStringO공예포털에 신청하여 발급 받은 인증키
keywordStringX검색하고자하는 키워드
numOfrowsStringX한 페이지 결과 수
pageNoStringX페이지번호

샘플URL

검색키워드 "공모"를 사업명 또는 사업내용에 포함한 사업아카이브 정보를 검색요청

https://craft.kcdf.kr/openApi/rest/list/bsnsArchive?serviceKey={발급서비스키}&numOfrows=10&pageNo=1&keyword=%EA%B3%B5%EB%AA%A8

출력결과 필드

출력결과 필드 - 요청변수, 데이터타입, 설명으로 구성
요청변수데이터타입설명
totalCountString전체 count
pageNoString요청파라미터-페이지번호
numOfRowsString요청파라미터-한페이지 결과수
countString조회
snString사업 순번
titleString사업명
fieldString분류
yearString사업연도
placeString장소
beginDyString시작일 (YYYY-MM-DD)
endDyString종료일 (YYYY-MM-DD)
detailUrlString상세화면 URL

응답결과 메시지

<response>
              <header>...</header>
              <body>
              <items>
              <item>
              <sn>354</sn>
              <title>2026 KCDF 공모전시·중견</title>
              <field>KCDF 공모전시</field>
              <year>2026</year>
              <place>KCDF갤러리</place>
              <beginDy>2026-08-26</beginDy>
              <endDy>2026-09-06</endDy>
              </item>
              </items>
              </body>
            </response>

비고/에러 메시지

<response>
            <resultMsg>APPLICATION ERROR</resultMsg>
            </response>