검색 OpenAPI 안내(최종 수정일 : 2006.9.27, 엑셀
다운로드)
- 상품 검색 요청 URL : http://www.aladin.co.kr/ttb/api/search.aspx?TTBKey=ttb키값&Query=검색어&옵션요청변수
- GET방식이나 POST 방식으로 각 설정값들을 넘겨주면 됩니다.
- 출력은 기본적으로 확장RSS형식입니다. 부분적으로는 A9의 OpenSearch방식을 도입했습니다.
- http://opensearch.a9.com/ 에 자세한 스펙이 나와있습니다.
- 출력방법은 확장RSS이외에 JSON형식으로도 출력이 가능합니다. 출력필드는 확장RSS(OpenSearch)일때와 동일합니다.
- 분류 ID값은 알라딘 모든 분야 카테고리 엑셀문서를 참고하십시오.
- 법입/기업/단체에서 알라딘 OpenAPI를 사용하시기를 원하시면 TTB기업회원안내를 참고해주십시오.
검색 입력용 API 스펙
| 구분 | 요청변수 | 변수종류 | 설명 |
| 필수 | TTBKey | 문자열 | ttbkey키 |
| Query | 문자열 | 검색어 | |
| 옵션 (옵션 조정 변수가 없을 경우에는 기본값으로 검색) |
QueryType | Title(기본값) : 제목검색 Author : 저자검색 Publisher : 출판사검색 |
검색 종류 |
| SearchTarget | Book(기본값) : 도서 Music : 음반 DVD : DVD Beauty : 화장품 Gift : 기프트 |
검색 대상 Mall | |
| Start | 1이상, 양의 정수(기본값:1) | 검색결과 시작페이지 | |
| MaxResults | 1이상 100이하, 양의 정수(기본값:10) | 검색결과 한 페이지당 최대 출력 개수 | |
| Sort | PublishTime(기본값) : 출간일 Title : 제목 SalesPoint : 판매량 CustomerRating 고객평점 MyReviewCount :마이리뷰갯수 |
정렬순서 | |
| Cover | Big : 큰 크기 Mid(기본값) : 중간 크기 Small : 작은 크기 Mini : 매우 작은 크기 None : 없음 |
표지크기 | |
| TitleCut | 0이상 40이하 양의 정수. 0일경우 자르지 않음(기본값:0) |
제목 글자수 자르기 | |
| CategoryId | 양의정수 - 분야의 고유 번호(기본값:0, 전체) (참고 : 알라딘 모든 분야 카테고리) |
특정 분야로 검색결과를 제한함 | |
| Output | OS(기본값) : RSS(OpenSearch방식) JS : JSON방식 |
출력방법 | |
| Partner | 문자 | 파트너코드. 제휴사의 경우 파트너코드 입력으로 제휴사 유효성 체크. |
검색 출력용 API 스펙
| 필드명 | 설명 | 자료형 |
| opensearch:totalResults | 총 검색 결과 개수 | 정수형 |
| opensearch:startIndex | 현재 페이지 | 정수형 |
| opensearch:itemsPerPage | 한 페이지당 출력 결과 개수 | 정수형 |
| opensearch:Query | 요청 쿼리 | 문자열 |
| aladdin:searchCategoryId | 특정 분야로 검색을 제한한 경우 분야의 고유번호 출력 | 정수형 |
| aladdin:searchCategoryName | 특정 분야로 검색을 제한한 경우 분야의 이름 출력 | 문자열 |
| item < category | '알라딘'이 출력 | 문자열 |
| item < content:encoded | 바로 사용할 수 있는, HTML이 포함된 간략한 상품 설명 | 문자열 |
| item < description | HTML이 없는 상품설명 | 문자열 |
| item < pubDate item < dc:date |
도서 출간일 | 날짜 |
| item < dc:creator | 'aladdin'이 출력 | 문자열 |
| item < aladdin:priceStandard | 상품 정가 | 숫자(통화) |
| item < aladdin:priceSales | 알라딘에서 판매하는 판매가(수시로 변동 가능) | 숫자(통화) |
| item < aladdin:stockStatus | 상품의 재고 상태. 재고 보유 상태에서는 특별한 문자도 들어가있지 않으며 품절,절판 등의 특별한 상태일때만 문자열이 출력 |
문자열 |
| item < aladdin:mileage | 상품 구입시 지급되는 마일리지 | 숫자(통화) |
| item < aladdin:cover | 상품 표지 URL | 문자열(URL) |
| item < aladdin:categoryId | 상품 대표 분야의 고유번호(알라딘은 복수 분류체계,그 중 대표 분류 하나)(참고 : 알라딘 모든 분야 카테고리) | 숫자 |
| item < aladdin:categoryName | 대표 분류의 상위 분류들(분류 히스토리, "<"를 기준으로 나누어져 있음) | 문자열 |
요청 URL
• 상품 직접 연결 : http://www.aladin.co.kr/ttb/api/product.aspx?isbn=isbn넘버&type=타입값&TTBKey=ttb인증키값
상품 연결용 요청 변수 (request parameter)
| 요청 변수 | 값 |
type |
1(기본값), 2, 3, 4, 5 |
상품 연결용 요청 변수 설명
| 값 | 설명 | 예시 | ||
| 1(기본값. 생략시에는 1번 타입) | 상품 큰 이미지(이미지 사이즈 width = 85px) + (하단에) 상품 제목 |
|
||
| 2 | 상품 큰 이미지만 (이미지 사이즈 width = 85px) |
 |
||
| 3 | 상품 큰 이미지 + (우측에) 상품 제목 (하단에) 저자이름 + 출판사 |
|
||
| 4 | 상품 (작은) 이미지만 (이미지 사이즈 width = 75px) |
 |
||
| 5 | 상품 작은 이미지 + (하단에) 상품 제목 |
|
||
