공공데이터 개방•공유•활용 체계 개발

Open API 활용가이드

 Open API 활용가이드

목차

1. API 서비스 명세......................................................................................................................................................3

1.1 HACCP 제품이미지 및 포장지표기정보 서비스.......................................................................................................... 3

가. API 서비스 개요.............................................................................................................................................................. 3

나. 상세기능 목록.................................................................................................................................................................. 3

다. Open API 에러 코드 정리........................................................................................................................................... 4

1. 서비스 명세

-2-
 Open API 활용가이드

1.1 HACCP 제품이미지 및 포장지표기정보 서비스

가. 서비스 개요

API 명(국문) HACCP 제품이미지 및 포장지표기정보 서비스

(HACCP 제품이미지 및 포장지표기정보) 제품이미지 및

API 서비스 정보 포장지표기정보(품목보고번호, 축산/식품구분, 제품명, 원재료,
API 설명
알레르기유발물질, 영양성분, 바코드, 유형명, 유형의상태,

제조원, 판매원, 용량, 제품이미지 URL, 메타이미지 URL)를 제공

[O] 서비스 Key [ ] 인증서 (GPKI)

서비스 인증/권한
[] Basic (ID/PW) [ ] 없음

메시지 레벨
[ ] 전자서명 [ ] 암호화 [O] 없음
암호화
API 서비스 보안
전송 레벨 암호화 [ ] SSL [ O ] 없음
적용 기술 수준
[ ] SOAP 1.2

(RPC-Encoded, Document Literal, Document Literal Wrapped)

인터페이스 표준
[ O ] REST (GET)

[ ] RSS 1.0 [ ] RSS 2.0 [ ] Atom 1.0 [ ] 기타

교환 데이터 표준 [ O ] XML [ O ] JSON [ ] MIME [ ] MTOM

API 서비스 서비스 URL http://apis.data.go.kr/B553748/CertImgListService

배포정보 서비스 WADL

서비스 버전 1.0

서비스 시작일 2018-12-26 서비스 배포일 2018-12-25

서비스 이력 2018-12-26 : 서비스 시작

메시지교환유형 [O] Request-Response [ ] Publish-Subscribe

-3-
 Open API 활용가이드

[ ] Fire-and-Forgot [ ] Notification

서비스 제공자 박정일 / 정보통계팀 / 043-928-0031 / jipark@haccp.or.kr

데이터 갱신주기 일 1회

나. 상세기능 목록

일련번호 서비스명(국문) 상세기능명(영문) 상세기능명(국문)

HACCP 제품이미지 및 getCertImgListServ

1 HACCP 제품이미지 및 포장지표기정보 조회
포장지표기정보 서비스 ice
(1) [HACCP 제품이미지 및 포장지표기정보 조회] 상세기능 명세

상세기능 번호 1 상세기능 유형 조회

상세기능명(국문) HACCP 제품이미지 및 포장지표기정보 조회

상

세 품목보고번호, 축산/식품구분, 제품명, 원재료, 알레르기유발물질, 영양성분,

기 상세기능 설명 바코드, 유형명, 유형의상태, 제조원, 판매원, 용량, 제품이미지 URL, 메타이미지

능 URL 를 제공

정 Call Back URL http://apis.data.go.kr/B553748/CertImgListService/getCertImgListService

보
최대 메시지 사이즈 [ 4000bytes]

평균 응답 시간 [ 500 ms] 초당 최대 트랜잭션 [ 30 tps]

① 요청 메시지 명세

항목크 항목
항목명(영문) 항목명(국문) 샘플데이터 항목설명
기 구분

공공데이터포털에서 발급받은 
ServiceKey 인증키 100 1 -
인증키

prdlstReportNo 품목보고번 50 0 201704760012 제품에 부여되는 고유식별번호

-4-
 Open API 활용가이드

prdlstNm 제품명 500 0 돈까스 제품명

returnType 리턴타입 4 0 xml 결과 응답 형식

pageNo 페이지 번호 10 0 1 페이지 번호

한 페이지
numOfRows 3 0 10 한 페이지 결과 수
결과 수

※ 항목구분 : 필수(1), 옵션(0), 1 건 이상 복수건(1..n), 0 건 또는 복수건(0..n)

② 응답 메시지 명세

항목구
항목명(영문) 항목명(국문) 항목크기 샘플데이터 항목설명
분

resultCode 결과코드 4 1 OK 결과코드

resultMessage 결과메시지 50 1 success 결과메시지

한 페이지 결과 요청한 한 페이지

numOfRows 3 1 10
수 결과 수

요청한 페이지
pageNo 페이지 번호 10 1 1
번호

요청한 조건에

totalCount 전체 결과 수 10 1 1 만족하는 총 결과

건수

Items 0..n

rnum 출력번호 10 1 1 출력에 대한 행번호

prdlstReportNo 품목보고번호 50 1 201704760012 품목보고번호

productGb 축산/식품구분 10 1 축산물 축산/식품구분

-5-
 Open API 활용가이드

prdlstNm 제품명 500 1 미소담은 돈까스 제품명

돼지고기 68.95%(

국내산),우리밀빵가루

[밀가루 89%(국내산),

해바라기유(수입산),

생이스트,유기농설탕,

rawmtrl 원재료 2000 0 소금],우리밀튀김가루 원재료

[밀가루 78.17%(

국내산),감자전분(

국내산),발아통밀가루

(국내산),현미,

구운소금],정제수

allergy 알레르기유발물질 100 0 돼지고기,밀 함유 알레르기유발물질

nutrient 영양성분 3000 0 알수없음 영양성분

barcode 바코드 50 0 8809549135325 바코드

prdkind 유형명 50 0 분쇄가공육제품 유형명

prdkindstate 유형의상태 100 0 비살균제품 유형의상태

㈜그린팜푸드

농업회사법인
manufacture 제조원 300 0 제조원
전주완주군봉동읍은하

율소로 179-47

seller 판매원 300 0 ㈜그린팜푸드 판매원

농업회사법인

전주완주군봉동읍은하

-6-
 Open API 활용가이드

율소로 179-47

capacity 용량 300 0 480g 용량

http://fresh.ihaccp.or.kr

/prdimg/2017
imgurl1 제품이미지 URL 100 0 제품이미지 URL
/201704760012

/201704760012-1.jpg

http://fresh.ihaccp.or.kr

/prdimg/2017
imgurl2 메타이미지 URL 100 0 메타이미지 URL
/201704760012

/201704760012-2.jpg

※ 항목구분 : 필수(1), 옵션(0), 1 건 이상 복수건(1..n), 0 건 또는 복수건(0..n)

③ 요청 / 응답 메시지 예제

REST(URI)

http://apis.data.go.kr/B553748/CertImgListService/getCertImgListService?ServiceKey=서비스키(URL

Encode)&prdlstReportNo=201704760012

응답 메시지

<response>
<header>
<resultCode>OK</resultCode>
<resultMessage>success</resultMessage>
</header>
<body>
<numOfRows>10</numOfRows>
<pageNo>1</pageNo>
<totalCount>1</totalCount>
<items>

-7-
 Open API 활용가이드

<item>
<rnum>1</rnum>
<prdlstReportNo>201704760012</prdlstReportNo>
<productGb>축산물</productGb>
<prdlstNm>미소담은 돈까스</prdlstNm>
<rawmtrl>돼지고기 68.95%(국내산),우리밀빵가루[밀가루 89%(국내산),해바라기유(수입산),생이스트,
유기농설탕,소금],우리밀튀김가루[밀가루 78.17%(국내산),감자전분(국내산),발아통밀가루(국내산),현미,
구운소금],정제수</rawmtrl>
<allergy>돼지고기,밀 함유</allergy>
<nutrient>알수없음</nutrient>
<barcode>8809549135325</barcode>
<prdkind>분쇄가공육제품</prdkind>
<prdkindstate>비살균제품</prdkindstate>
<manufacture>㈜그린팜푸드 농업회사법인 전주완주군봉동읍은하율소로 179-47</manufacture>
<seller>㈜그린팜푸드 농업회사법인 전주완주군봉동읍은하율소로 179-47</seller>
<capacity>480g</capacity>
<imgurl1>http://fresh.ihaccp.or.kr/prdimg/2017/201704760012/201704760012-1.jpg</imgurl1>
<imgurl2>http://fresh.ihaccp.or.kr/prdimg/2017/201704760012/201704760012-2.jpg</imgurl2>
</item>
</items>
</body>
</response>

다. Open API 에러 코드 정리

에러코드 에러메세지 설명

1 APPLICATION_ERROR 어플리케이션 에러

10 INVALID_REQUEST_PARAMETER_ERROR 잘못된 요청 파라메터 에러

해당 오픈 API 서비스가 없거나

12 NO_OPENAPI_SERVICE_ERROR
폐기됨

20 SERVICE_ACCESS_DENIED_ERROR 서비스 접근거부

22 LIMITED_NUMBER_OF_SERVICE_REQUESTS_EXCEED 서비스 요청제한횟수 초과에러

-8-
 Open API 활용가이드

S_ERROR

30 SERVICE_KEY_IS_NOT_REGISTERED_ERROR 등록되지 않은 서비스키

31 DEADLINE_HAS_EXPIRED_ERROR 기한만료된 서비스키

32 UNREGISTERED_IP_ERROR 등록되지 않은 IP

99 UNKNOWN_ERROR 기타에러

-9-