Home > 알림 > Open API

Open API

Open API 사용방법

1. 사용 할 Open API 정하기

Open API 목록 메뉴의 서비스 항목을 확인합니다.

2. 명세서를 다운로드 받습니다.

명세서에는 Open API를 사용하기 위한 설명이 포함되어 있습니다.

open API 명세서
3. 인증키 발급

KBIOIS에서 제공하는 Open API는 RESTful 방식의 웹서비스 입니다. RESTful 웹서비스는 HTTP를 사용하는 웹기반 인터페이스로 GET 또는 POST 방식의 URI를 통해 서비스 되기에 파라미터의 값을 URL에 표기하여 페이지를 로딩합니다.
인증키를 발급 받기 위해서는 로그인을 하셔야 합니다.

open API 인증키 발급
4. URL 등록

KBIOIS에서 제공하는 Open API는 RESTful 방식의 웹서비스 입니다. RESTful 웹서비스는 HTTP를 사용하는 웹기반 인터페이스로 GET 또는 POST 방식의 URI를 통해 서비스 되기에 파라미터의 값을 URL에 표기하여 페이지를 로딩합니다.
인증키를 발급 받기 위해서는 로그인을 하셔야 합니다.

URL 등록
  1. ① Open API URL KBIOIS의 Open API 주소는 https://www.kbiois.or.kr/openapi/ 입니다.
  2. ② Open API 명 KBIOIS의 Open API 서비스는 고유명을 가지고 있습니다. 다운로드 받으신 명세표에 요청 주소가 표기되어 있습니다.
  3. ③ 기본인자 기본인자를 생략하면 명세표의 기본값으로 결과를 표기합니다. 인증키(KEY)는 발급을 받으신 후 발급 받은 인증키를 추가하여야 합니다. 만약 인증키가 없다면 기본값은 sample로 처리되어 10건 만 출력되므로 반드시 인증키를 입력하셔야 합니다. 호출문서(Type)은 xml 이나 json 등 출력하고자 하는 타입의 형태를 지정합니다. 기본값은 xml입니다. 페이지 위치(pIndex)는 출력하고자 하는 페이지 입니다. 데이터 수가 많은 경우에는 페이지 위치를 증가시키면서 여러 번에 나누어 호출하셔야 합니다. 페이지당 요청숫자(pSize)는 한 페이지에 출력될 건수입니다.
  4. ④ 요청인자 KBIOIS의 각 서비스 별로 별도로 지정한 인자 값 입니다. 이 요청인자는 요청인자가 제공되는 서비스만 가능합니다.
5. APP에서 Open API 요청

이제 Open API를 활용하여 새로운 App을 개발하였습니다. 개발 된 App에서 요청한 데이터가 여러분께서 만든 앱의 내용에 표시됩니다.

Open API 요청