공개 API 사용 안내
예스피씨에 기여해주신 데이터를 다시 사용하실 수 있도록, 2023년 3월 8일부터 예스피씨에 사용되는 데이터를 공개 API로 사용하실 수 있습니다. 별도의 인증키는 필요하지 않습니다.
단, 예스피씨 또한 Vercel의 무료 플랜 트래픽 제한을 적용받는 서비스이므로 해당 제한에 의하여 일일 사용이 중단될 수 있습니다. 이 점 유의하시어 개발에 참고하시기 바랍니다.
GET 바코드 조회
/api/product
바코드 번호를 바탕으로 제조사와 제품명을 조회하는 API입니다.
예시
- 요청:
/api/product?barcode=8801068406726 - 결과:
null
요청에 사용되는 매개변수
| 이름 | 형태 | 설명 | barcode | 문자열 | 바코드 번호를 전달합니다. |
응답
데이터 종류: json
resultCode
- 형식: 정수
- 전달받은 바코드에 대한 결과를 설명하는 항목입니다. HTTP 상태는 오류에 따라 다릅니다.
resultCode 응답 값의 예시 | 값 | HTTP 상태코드 | 설명 | 200 | 200 | 적어도 알려진 제조업체의 바코드입니다. 제품 데이터가 있을 수도 있습니다. |
400 | 400 | 국내에서 유통되는 바코드 번호 형식이 아닙니다. 바코드가 아닐 수도 있습니다. |
404 | 200 | 알 수 없는 제조업체의 알 수 없는 제품입니다. |
411 | 400 | 바코드의 길이가 짧거나 맞지 않습니다. 13자 혹은 18자 바코드인지 확인해주세요. |
manu
- 형식: 문자열
- 제조업체를 표시하는 항목입니다.
manu 응답 값의 예시 | 값 | 설명 | null | 제조업체를 알 수 없습니다. |
spc
- 형식: 참 거짓
- SPC 산하 계열사인지 알려줍니다.
spc 응답 값의 예시 | 값 | 설명 | false | SPC 그룹 계열사가 아닙니다. |
true | SPC 그룹 계열사입니다. |
barcode
color
- 형식: 문자열
- 결과 대화상자 표시에 사용하는 제조사별 대표 색상입니다. HEX 색상표 형식으로 표시됩니다.
color 응답 값의 예시 | 값 | 설명 | #30B3E7 | SPC 삼립을 표현하기 위해 사용됩니다. |
#DB5B9B | 비알코리아를 표현하기 위해 사용됩니다. |
#4063A0 | 파리크라상을 표현하기 위해 사용됩니다. |
null | 색상이 지정되어 있지 않거나 제조사를 알 수 없습니다. |
product
product 응답 값의 예시 | 값 | 설명 | null | 제품명을 알 수 없습니다. |