알라딘의 방대한 도서, 음반, DVD 등 상품 데이터를 키워드를 통해 검색할 수 있는 API입니다.
1. 기본 정보
- 요청 URL:
http://www.aladin.co.kr/ttb/api/ItemSearch.aspx - 응답 형식: XML, JSON (기본값: XML)
- 제한 사항:
- 한 페이지에 최대 50개 출력 가능
- 검색 결과는 최대 200개까지만 제공
요청 샘플 (URL)
[http://www.aladin.co.kr/ttb/api/ItemSearch.aspx?ttbkey=]
(http://www.aladin.co.kr/ttb/api/ItemSearch.aspx?ttbkey=)
[TTBKey]&Query=aladdin&QueryType=Title&MaxResults=10
&start=1&SearchTarget=Book&output=xml&Version=201311012. 상품 검색 API 요청(Request) 파라미터
| 구분 | 요청변수 | 변수종류 | 필수여부 | 설명 |
|---|---|---|---|---|
| 필수 | TTBKey | 문자열 | Y | 알라딘에서 부여받은 TTBKey 값 |
| Query | 문자열 | Y | 검색어 (제목, 저자 등) | |
| 옵션 | QueryType | 문자열 | N | 검색어 종류 - Keyword: 제목+저자 (기본값)- Title: 제목 검색- Author: 저자 검색- Publisher: 출판사 검색 |
| SearchTarget | 문자열 | N | 검색 대상 Mall - Book: 도서 (기본값)- Foreign: 외국도서- Music: 음반- DVD: DVD- Used: 중고샵- eBook: 전자책- All: 전체 | |
| Start | 양의 정수 | N | 검색결과 시작 페이지 (기본값: 1) | |
| MaxResults | 양의 정수 | N | 페이지당 출력 개수 (1~100, 기본값: 10) | |
| Sort | 문자열 | N | 정렬 순서 - Accuracy: 관련도 (기본값)- PublishTime: 출간일- Title: 제목- SalesPoint: 판매량- CustomerRating: 고객평점- MyReviewCount: 마이리뷰 개수 | |
| 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이면 제외) | |
| RecentPublishFilter | 양의 정수 | N | 최근 출간일 제한 필터 (0~60개월 사이) | |
| OptResult | 문자열 | N | 부가 정보 요청 (Array 형태, 쉼표 구분) 예: OptResult=ebookList,usedList |
3. OptResult 상세 옵션 (상품 검색 전용)
검색 시 추가 정보를 포함하고 싶을 때 OptResult 파라미터에 사용 가능한 값입니다.
- ebookList: 해당 종이책의 전자책(eBook) 정보
- usedList: 해당 상품에 등록된 알라딘/판매자 중고상품 정보
- fileFormatList: 전자책의 파일 포맷(ePub, PDF 등) 및 용량
