신간 리스트, 베스트셀러, 편집자 추천 리스트 등 알라딘에서 제공하는 다양한 상품 리스트를 조회하는 API입니다.
1. 기본 정보
- 요청 URL:
http://www.aladin.co.kr/ttb/api/ItemList.aspx - 응답 형식: XML, JSON (기본값: XML)
- 조회 제한:
- 한 페이지당 최대 50개 출력 가능
- 총 결과는 최대 200개까지만 조회 가능
요청 샘플 (URL)
[http://www.aladin.co.kr/ttb/api/ItemList.aspx?ttbkey=]
(http://www.aladin.co.kr/ttb/api/ItemList.aspx?ttbkey=)
[TTBKey]&QueryType=ItemNewAll&MaxResults=10&
start=1&SearchTarget=Book&output=xml&Version=201311012. 상품 리스트 API 요청(Request) 파라미터
| 구분 | 요청변수 | 변수종류 | 필수여부 | 설명 |
|---|---|---|---|---|
| 필수 | TTBKey | 문자열 | Y | 알라딘에서 부여받은 TTBKey 값 |
| QueryType | 문자열 | Y | 리스트 종류 - ItemNewAll: 신간 전체 리스트- ItemNewSpecial: 주목할 만한 신간 리스트- ItemEditorChoice: 편집자 추천 (분야 지정 필수)- Bestseller: 베스트셀러- BlogBest: 블로거 베스트셀러 | |
| 옵션 | SearchTarget | 문자열 | N | 조회 대상 Mall - Book(기본값), Foreign, Music, DVD, Used, eBook, All |
| SubSearchTarget | 문자열 | N | SearchTarget=Used일 때 상세 지정 (Book, Music, DVD) | |
| Start | 양의 정수 | N | 검색결과 시작 페이지 (기본값: 1) | |
| MaxResults | 양의 정수 | N | 페이지당 출력 개수 (1~100, 기본값: 10) | |
| Cover | 문자열 | N | 표지 크기 선택 - Big: 200px- MidBig: 150px- Mid: 85px (기본값)- Small: 75px- Mini: 65px- None: 없음 | |
| CategoryId | 양의 정수 | N | 특정 분야(카테고리)로 리스트 제한 (기본값: 0) | |
| Output | 문자열 | N | 출력 방법: XML(기본값), JS(JSON 방식) | |
| Partner | 문자열 | N | 제휴사 파트너 코드 | |
| includeKey | 양의 정수 | N | 1 설정 시 링크에 TTBKey 포함 (기본값: 0) | |
| InputEncoding | 문자열 | N | 검색어 인코딩 설정 (기본값: utf-8) | |
| Version | 정수형 날짜 | N | API 버전 설정 (최신: 20131101) | |
| outofStockfilter | 양의 정수 | N | 품절/절판 상품 필터링 (1이면 제외) | |
| Year, Month, Week | 정수 | N | QueryType=Bestseller인 경우 특정 주간 조회예: Year=2022&Month=5&Week=3 | |
| OptResult | 문자열 | N | 부가 정보 요청 (Array 형태, 쉼표 구분) 예: OptResult=ebookList,usedList |
3. OptResult 상세 옵션 (상품 리스트 전용)
리스트 조회 시 추가 정보를 포함하고 싶을 때 OptResult 파라미터에 사용 가능한 값입니다.
- ebookList: 해당 종이책의 전자책(eBook) 정보
- usedList: 해당 상품에 등록된 중고상품 정보
- fileFormatList: 전자책의 파일 포맷 및 용량 정보
