토대연구DB
인문사회분야 토대연구 유형별DB
HOME ICON 토대연구DB > 토대 Open-API > Open-API 소개

Open-API 소개


Open-API 소개

  • Open-API
    • 토대연구 DB 구축 사업에서 구축된 인문/사회/예술분야의 다양한 자료학, 사전학, 총서학 등의 자료를 검색하여 이용할 수
      있도록 하는 외부에 공개하는 인터페이스.
  • Open-API 주소
    • http://ffr.krm.or.kr/base/openapi/openAPI_todaeSearch.html

  • 요청 변수(Request Parameter)

  • 요청변수 변수명 유형 값범위(UTF8) 필수 비고
    sysId 기관인증코드 String 기관마다 부여하는 고정된 인증키 필수 인증키값
    tdDataListCd 검색자료유형 String 토대DB 구축리스트
    ALL:전체자료 검색
    (기본으로 ALL적용)
    keyword 검색어 String NULL값 불가
    sort_type 결과정렬필드 String score : 색인우선순위
    title : 제목
    NULL인 경우score
    sort 결과정렬방식 String asc : 오름차순
    desc : 내림차순
    NULL인 경우 asc
    currentPageNumber 현재페이지번호 Integer 1~ NULL인 경우 1
    listPerPage 페이지리스트 수 Integer 10~300 NULL인경우 10

  • 출력결과 필드(Response Field)
  • 항목 항목명 반복 값(UTF8) 설명
    totalcount 검색결과건수 N Integer 검색결과 총 건수
    eachcount 각DB 검색결과건수 N Integer 키워드에 대한 각 DB별 검색 결과
    건 수
    error 오류코드 N String 에러코드
    errorMessage 오류내용 N String 에러메세지
    project_name 프로젝트명 Y String 연구 프로젝트명 (과제명)
    research_master 대표연구자 Y String 대표연구자 (주저자)
    research_other 공동연구자 Y String 공동연구자 (공동저자)
    master_company 대표연구기관 Y String 대표연구기관(발행처)
    key 데이터 고유키 Y String 상세보기를 위한 해당 레코드의
    고유번호
    stype 토대DB 유형 Y Dic:사전학
    Book:총서학
    Data:자료학
    토대DB 자료 유형
    info1 항목1 Y String 검색결과 표기항목1
    info2 항목2 Y String 검색결과 표기항목2
    info3 항목3 Y String 검색결과 표기항목3
    info4 항목4 Y String 검색결과 표기항목4
    info5 항목5 Y String 검색결과 표기항목5
    info1_desc 항목1의 의미 Y String 표기항목1의 의미
    info2_desc 항목2의 의미 Y String 표기항목2의 의미
    info3_desc 항목3의 의미 Y String 표기항목3의 의미
    info4_desc 항목4의 의미 Y String 표기항목4의 의미
    info5_desc 항목5의 의미 Y String 표기항목5의 의미
    keywordString 키워드 스트링 Y String 키워드 스트링
    (검색을 위한 데이터 문자열)
    url 상세url 링크 Y String 상세보기 직접링크 url
    pub_date 사업년도 N Integer 사업선정년도(발행년도)