GobizKOREA
내용 바로가기
  • 고객지원센터
  • 개방형API 안내/신청

개방형 API 종류

Open API

1. 기업정보 API

1) 설명

기업정보 API는 고비즈코리아에 등록된 기업에서 정보제공에 동의한 기업정보를 조회하고자 할 때 사용할 수 있는 API이다.
기업정보 API는 한번에 복수개의 기업정보를 요청할 수 있으며 데이터 항목 및 JSON 구조는 배열 형태로 정의한다.

2) 요청 URL

{baseURL}/api/entrpsInfos.do

3) HTTP Request/Response

HTTP Request/Response
구분 Method Content-Type Data Format
요청 GET/POST application/json JSON
응답 application/json JSON

4) 이용가이드 안내 (이용가이드 문서를 제공하고 있습니다. 더 자세한 내용이 필요하신 분은 개발에 참고하세요)

2. 상품정보 API

1) 설명

상품정보 API는 상품정보가 필요한 경우 사용할 수 있는 API 이다. 상품정보 API는 키워드 및 카테고리코드를 이용하여 조회를 요청할 수 있으며 조회결과 데이터 항목 및 JSON 구조는 배열 형태로 정의한다.
1회 조회 요청시 최대반환건수는 플랫폼관리자에 의해서 설정이 되어 있다. 따라서 조회결과 데이터건수가 1회 최대반환건수를 초과하는 경우에는 페이징처리를 하여 반복해서 조회해야 한다.

2) 요청 URL

{baseURL}/api/goodsInfos.do

3) HTTP Request/Response

HTTP Request/Response
구분 Method Content-Type Data Format
요청 POST application/json JSON
응답 application/json JSON

4) 이용가이드 안내 (이용가이드 문서를 제공하고 있습니다. 더 자세한 내용이 필요하신 분은 개발에 참고하세요)

3. 카테고리 API

1) 설명

카테고리API는 ‘온라인수출 통합플랫폼(GobizKorea.com)’ 의 상품 카테고리 정보를 조회하고자 할 때 사용할 수 있는 API 이다. 조회 시에 카테고리코드를 지정하도록 되어 있는데, 최초 최상위인 ‘ROOT’ 로 조회한 후 조회된 코드(카테고리) 에 속한 하위 카테고리만 조회하여 반환한다. 참고로 상품의 카테고리는 3Depth로 구성되어 있다.

2) 요청 URL

{baseURL}/api/ctgryCodes.do

3) HTTP Request/Response

HTTP Request/Response
구분 Method Content-Type Data Format
요청 POST application/json JSON
응답 application/json JSON

4) 이용가이드 안내 (이용가이드 문서를 제공하고 있습니다. 더 자세한 내용이 필요하신 분은 개발에 참고하세요)

4. 주문정보 API

1) 설명

주문정보 API는 API사용자의 쇼핑몰에서 상품구매자가 ‘온라인수출 통합플랫폼(GobizKorea.com)’ 에서 제공한 상품을 주문하였을 때 ‘온라인수출 통합플랫폼(GobizKorea.com)’ 쪽에 주문된 정보를 전송할 때 사용하는API 이다. 주문정보 API는 한번에 복수개의 주문정보를 전송할 수 있으며, 주문정보 송신에 필요한 데이터 항목 및 JSON 구조는 배열 형태로 정의한다.

2) 요청 URL

{baseURL}/api/orderInfoSet.do

3) HTTP Request/Response

HTTP Request/Response
구분 Method Content-Type Data Format
요청 POST application/json JSON
응답 application/json JSON

4) 이용가이드 안내 (이용가이드 문서를 제공하고 있습니다. 더 자세한 내용이 필요하신 분은 개발에 참고하세요)

5. 판매정보 API

1) 설명

판매정보 API는 API사용자의 쇼핑몰에서 상품구매자가 ‘온라인수출 통합플랫폼(GobizKorea.com)’ 의 상품을 판매완료 하였을 때 ‘온라인수출 통합플랫폼(GobizKorea.com)’ 쪽에 판매정보를 전송하는 용도로 사용하는API 이다. 판매정보 API는 한번에 복수개의 판매정보를 전송할 수 있으며, 판매정보 송신에 필요한 데이터 항목 및 JSON 구조는 배열 형태로 정의한다.

2) 요청 URL

{baseURL}/api/salesInfoSet.do

3) HTTP Request/Response

HTTP Request/Response
구분 Method Content-Type Data Format
요청 POST application/json JSON
응답 application/json JSON

4) 이용가이드 안내 (이용가이드 문서를 제공하고 있습니다. 더 자세한 내용이 필요하신 분은 개발에 참고하세요)

6. 상품정보변경조회 API

1) 설명

상품정보변경조회 API는 ‘온라인수출 통합플랫폼(GobizKorea.com)’ 에서 제공한 상품정보의 변경이 있을 경우 변경된 상품정보의 정보만을 조회하여 제공해주는 API이다. (이미 API를 이용해서 취득한 상품 중에서 변경된 상품만을 조회) 응답 데이터 항목 및 JSON 구조로 정의한다.

2) 요청 URL

{baseURL}/api/goodsInfosUptd.do

3) HTTP Request/Response

HTTP Request/Response
구분 Method Content-Type Data Format
요청 POST application/json JSON
응답 application/json JSON

4) 이용가이드 안내 (이용가이드 문서를 제공하고 있습니다. 더 자세한 내용이 필요하신 분은 개발에 참고하세요)