레거시 API 연동 (v0.3)
본 가이드는 기존 전용 API(v0.3)를 이용해 상품 데이터를 연동 중인 고객사를 위한 페이지입니다.
해당 규격은 상품의 기본 정보부터 브랜드, 카테고리, 상세 가격 정보를 계층 구조(Object)로 수집합니다. 만약 신규로 연동을 진행하시는 고객사라면, 본 페이지 대신 [표준 API 직접 연동] 가이드를 참고해 주시기 바랍니다.
1. 개요 및 연동 정보
고객사의 상품 데이터를 genser API 엔드포인트로 전송하여 검색 엔진에 반영합니다.
Endpoint (운영)
HTTP Method
POST
인증 방식
Header에 x-api-key: {발급받은_API_KEY} 포함
2. 데이터 업데이트 및 반영 시점
데이터는 성격별로 반영 시점이 다릅니다.
일반 상품 정보 (신규/수정): 매일 오전 00:15 일괄 업데이트 (Batch)
품절 정보 (Status): 데이터 수신 즉시 실시간 반영
업데이트 방법: 상품 정보가 변경되거나 신규 등록될 때마다 동일한 API를 다시 호출하여 최신 데이터를 전송해 주세요.
3. 상세 데이터 규격 (v0.3)
필드 정의서에 따른 주요 항목들입니다.
3.1 검색 상품 (Product)
code
String
Y
상품 고유 코드
name
String
Y
상품명
brand
Object
Y
브랜드 정보
└ code
String
Y
브랜드 이름
└ name
String
Y
브랜드코드
categories
Array
Y
카테고리 정보
└ largeCode
String
Y
대분류 코드
└ largeName
String
Y
대분류 이름
└ midCode
String
N
중분류 코드
└ midName
String
N
중분류 이름
└ smallCode
String
N
소분류 코드
└ smallName
String
N
소분류 이름
└ detailCode
String
N
세분류 코드
└ detailName
String
N
세분류 이름
image
Object
Y
상품 이미지 정보
└ mainUrl
String
Y
대표 이미지 url
└ detailUrls
Array
Y
상품 상세 이미지 URL 배열
└ productUrl
String
N
제품 상세 페이지 url
priceInfo
Object
Y
가격 정보
└ currency
String
Y
통화 코드
└ price
Double
Y
상품 가격
└ salePrice
Double
Y
상품 할인가격
└ salePercent
Double
N
상품 할인율
rating
Object
N
리뷰 정보
└ reviewCount
Integer
N
리뷰수
└ avgRating
Double
N
평균 평점
└ avgDeliveryRating
Double
N
평균 배송 평점
createdAt
String
Y
상품 등록일
createdAtEpochMilli
Long
N
상품 등록일
isInStock
Boolean
N
상품 재고 여부
attribute
Object
N
상품 속성 정보
└ description
String
N
상품 상세 정보
└ keywords
Array
N
주요 키워드
└ colors
Array
N
색상
└ series
String
N
시리즈
└ situations
Array
N
상황
└ seasons
Array
N
계절
└ materials
Array
N
소재
└ gender
Array
N
성별
└ ages
Array
N
연령대
└ sizes
Array
N
공통 사이즈
└ features
Array
N
상품 특징
└ styles
Array
N
상품 스타일
└ installTime
Integer
N
설치 예상 시간 (분)
└ flavor
Array
N
맛
└ maxLoad
String
N
최대 하중
└ skinType
Array
N
적합 피부타입
└ spf
Array
N
자외선 차단 지수
└ fragrance
Array
N
향
└ energyGrade
String
N
에너지효율 등급
└ originCountry
String
N
제조국 / 원산지
└ promotions
String
N
상품 프로모션
└ isBroadcast
Boolean
N
방송된 상품 유무
└ width
Double
N
가로
└ height
Double
N
높이
└ depth
Double
N
세로
└ skinColors
Array
N
피부색상
└ diseaseInfos
Array
N
질병종류
└ functions
Array
N
기능
└ applyAreas
Array
N
적용 부위
└ alternatives
Array
N
대체 상품 리스트
customs
Array
N
고객사 커스텀 데이터
└ name
String
Y
이름
└ values
Array
N
값
3.2 필터 (Filters)
httpStatus
http 상태
└ code
String
Y
HTTP 상태코드
└ reasonPhrase
String
Y
HTTP 상태메세지
processCode
String
Y
요청의 성공여부 “OK“ or “FAIL“
processValue
Object
Y
요청의 결과값
3.3 콘텐트 (Content)
콘텐트 수집 API 입니다.
code
String
Y
콘텐츠 코드
name
String
Y
콘텐츠 이름
categories
Array
Y
상품 카테고리
└ largeCode
String
Y
대분류 코드
└ largeName
String
Y
대분류 이름
└ midCode
String
N
중분류 코드
└ midName
String
N
중분류 이름
└ smallCode
String
N
소분류 코드
└ smallName
String
N
소분류 이름
└ detailCode
String
N
세분류 코드
└ detailName
String
N
세분류 이름
image
Object
Y
상품 이미지 정보
└ mainUrl
String
Y
대표 이미지 url
└ detailUrls
Array
Y
상품상세이미지 url
└ productUrl
String
N
제품 상세 페이지 url
priceInfo
Object
Y
가격 정보
└ currency
String
Y
통화
└ price
Double
Y
상품 가격
└ salePrice
Double
Y
상품 할인가격
└ salePercent
Double
N
상품 할인율
createdAt
String
Y
상품 등록일
createdAtEpochMilli
Long
N
상품 등록일
languageCode
String
N
언어 코드
display
Object
N
전시 정보
└ isYn
Boolean
N
전시 여부
└ start
Long
Y
전시 시작 시간
└ end
Long
Y
전시 종료 시간
attribute
Object
N
상품 속성 정보
└ description
String
N
상품 설명
└ keywords
Array
N
주요 키워드
└ series
String
N
시리즈
└ location
String
N
위치
└ branchName
String
N
지점명
└ instructorName
String
N
강사명
└ sessionCount
Int
N
강의횟수
└ materialsPrice
Double
N
재료비
└ requiredSupplies
String
N
준비물
└ textbookInfo
String
N
교재정보
└ note
String
N
유의사항
└ cancellationRefundPolicy
String
N
강좌 취소 및 환불안내
└ phoneNumber
String
N
전화번호
└ lastOrder
Long
N
라스트오더 시간
└ menuName
Array
N
메뉴명
└ menuPrice
Array
N
메뉴 가격
└ menuDescription
Array
N
메뉴 설명
4. 응답 코드 (Response)
API 호출 후 응답 본문의 processCode를 통해 성공 여부를 확인합니다.
processCode "0": 정상 접수 (익일 00:15 반영 예정)
그 외 코드: 오류 발생 (응답 본문의
processValue메시지 확인 필요)
데이터 반복 안내
데이터가 Array 타입일 때, 데이터가 반복될 수 있습니다.
개발 가이드 팁
품절 정보를 실시간으로 반영하려면
inInstock필드를 포함하여 API를 즉시 호출하세요.상품 상세 정보가 수정된 경우, 변경된 필드뿐만 아니라 전체 스키마를 포함하여 다시 전송하는 것이 안전합니다.
Last updated
Was this helpful?