OpenAPI 안내

(최종 수정일 : 2014.6.27)
  • OpenAPI는 (1) 검색API와 (2) 하나의 상품을 열람하는API(이하 상품API) (3) 베스트셀러 등 각종 상품 리스트 API 등 크게 3가지로 나눠집니다.
  • 상품API는 하나의 상품만을 열람하므로 검색API의 결과보다 자세한 부가 정보가 더해진 결과가 나옵니다.
  • 검색API/상품API/리스트API의 결과는 모두 XML형식(기본값), json형식 형식으로 받으실 수 있습니다.
  • 요청방식은 GET방식과 POST방식에 상관없이 요청 가능합니다.
  • OpenAPI는 1일 5,000회로 제한됩니다. 5000회 이상을 원하시는 분은 ttb@aladdin.co.kr으로 연락바랍니다.
  • 분류 ID값은 알라딘 모든 분야 카테고리 엑셀문서를 참고하십시오.
  • 이전버젼(20070901)의 문서는 여기를 참고해주세요.
  • 보다 상세한 OpenAPI 매뉴얼은 여기를 참고해주세요.


상품 리스트 API


제공 리스트 종류
  • 신간 전체 리스트
  • 주목한 만한 신간 리스트
  • 편집자 추천 리스트(카테고리로만 조회 가능 - 국내도서/음반/외서 만 지원)
  • 베스트셀러
  • 북플 베스트셀러(국내도서 만 조회 가능)
요청 방법

리스트 요청(Request) 파라미터 스펙
구분 요청변수 변수종류 설명
필수 TTBKey 문자열 부여받은 TTBKey값
QueryType ItemNewAll : 신간 전체 리스트
ItemNewSpecial : 주목할 만한 신간 리스트
ItemEditorChoice : 편집자 추천 리스트 (카테고리로만 조회 가능 - 국내도서/음반/외서만 지원)
Bestseller : 베스트셀러
BlogBest : 북플 베스트셀러 (국내도서만 조회 가능)
리스트 종류
옵션
(옵션 조정 변수가 없을 경우에는 기본값으로 검색)
SearchTarget Book: 도서
Foreign : 외국도서
Music : 음반
DVD : DVD/블루레이
Used : 온라인 중고샵(도서/음반/DVD 등)
eBook: 전자책
조회 대상 Mall
SubSearchTarget Book : 도서
Music : 음반
DVD : DVD/블루레이
SearchTarget이 중고(Used)인 경우, 서브 Mall 지정
Start 1이상, 양의 정수(기본값:1) 검색결과 시작페이지
MaxResults 1이상 50이하, 양의 정수(기본값:10) 검색결과 한 페이지당 최대 출력 개수
Cover Big : 큰 크기
Mid(기본값) : 중간 크기
Small : 작은 크기
Mini : 매우 작은 크기
None : 없음
표지크기
CategoryId 양의정수 - 분야의 고유 번호(기본값:0, 전체)
(참고 : 알라딘 모든 분야 카테고리)
특정 분야로 리스트 결과를 제한함
Output XML(기본값) : REST XML형식
JS : JSON방식
출력방법
Partner 문자 파트너코드. 제휴사의 경우 파트너코드 입력으로 제휴사 유효성 체크.
includeKey 양의정수(기본값:0) includeKey가 1인 경우 결과의 상품페이지 링크값에 TTBKey가 포함됨.
InputEncoding 문자열(인코딩의 영문이름 - 기본값:utf-8) 검색어의 인코딩 값을 설정. "utf-8"이나 "euc-kr"과 같은 인코딩의 영문이름.
Version 정수형 날짜
(기본값: 20070901)
검색API의 Version(날짜형식)을 설정.
(최신버젼: 20131101)
OptResult 문자(Array) - 추가로 받아올 정보 선택
ebookList : 해당 종이책의 전자책 정보
usedList : 해당 상품에 등록된 중고상품 정보
fileFormatList : 전자책의 포맷 및 용량
* 요청시 OptResult=ebookList,usedList와 같은 형태로 요청







댓글(0) 먼댓글(0) 좋아요(2)
좋아요
북마크하기찜하기





요청 방법


  • 요청 URL : http://www.aladin.co.kr/ttb/api/ItemLookUp.aspx
  • 요청 URL샘플 : http://www.aladin.co.kr/ttb/api/ItemLookUp.aspx?ttbkey=TTBKey&itemIdType=ISBN13&ItemId=도서의ISBN&output=xml
  • "상품 조회 응답(Reponse) 결과값"의 스펙은 "검색 응답(Reponse) 결과값"과 동일한 결과에 단순히 부가정보가 추가되어지는 것임.
  • 도서의 경우
  • 분류 ID값은 알라딘 모든 분야 카테고리 엑셀문서를 참고하십시오.
  • 보다 상세한 OpenAPI 매뉴얼은 여기를 참고해주세요.


상품 조회 요청(Request) 파라미터

구분 요청변수 변수종류 설명
필수 TTBKey 문자열 부여받은 TTBKey값
ItemId 문자열/숫자 상품을 구분짓는 유일한 값
(ItemIdType으로 정수값과 ISBN중에 택일)
옵션
(옵션 조정 변수가 없을 경우에는 기본값으로 조회)
ItemIdType
  • ISBN(기본값) : ISBN10자리
  •  ISBN13 : ISBN13자리
  •  ItemId
조회용 파라미터인 ItemId가 ISBN으로 입력되었는지, 알라딘고유의"ItemId"값으로 입력되었는지 선택
Cover
  • Big : 큰 크기
  • Mid(기본값) : 중간 크기
  • Small : 작은 크기
  • Mini : 매우 작은 크기
  • None : 없음
표지크기
Output
  • XML(기본값) : REST XML형식
  • OS : 확장RSS(OpenSearch방식)
  • JS : JSON방식
출력방법
Partner 문자 파트너코드. 제휴사의 경우 파트너코드 입력으로 제휴사 유효성 체크.
Omitkey 양의정수(기본값:0) Omitkey가 1인경우 결과링크값에 TTBKey가 제외됨.
Version 정수형 날짜
(기본값: 20070901)
검색API의 Version(날짜형식)을 설정.
CallBack javascript function이름 호출후 불려질 javascript function의 이름을 지정.
output이 js인 경우에 한해 작동됨.
OptResult c2binfo 중고C2B(알라딘이 고객에게 매입하는 중고) 매입여부 및 매입가 조회.(버전 정보를 Version=20131101로 호출)



상품 조회 응답(Reponse) 결과값 스펙

필드명 설명 자료형
tile 제목  문자열
link 상품페이지 URL 주소  문자열(URL)
pubdate  출간일(출시일)  숫자
author  저자/아티스트  문자열
description  요약 설명구 문자열 
isbn  10자리 ISBN 숫자
isbn13  13자리 ISBN 숫자 
pricesales  판매가 숫자 
pricestandard  정가 판매가 
stockstatus  재고상태(정상유통일 경우 비어있음, 품절/절판 등) 문자열 
mileage  마일리지 숫자 
cover  커버(표지) 이미지(coversum/coveroff/covermini/cover150 등으로 응용가능) 문자열(URL) 
CategoryId  카테고리(분류) Id 숫자 
CategoryName  카테고리 명칭 문자열 
c2bsales 중고 C2B 매입 여부. 1이면 매입가능. 2면 매입불가 상태.(매입 여부는 수시로 변동되는 정보) 숫자 
c2bsales_price 중고 C2B 매입가. AA는 최상급 상태일 경우, A는 상급, B는 중급, C는 균일가매입으로 1천원(C가 0인 경우에는 균일가매입도 불가) 숫자(금액 원)
publisher  출판사(제작사/출시사) 문자열 
CustomerReviewRank  회원 리뷰 평점(별점 평균) : 0~10점(별0.5개당 1점) 숫자 
FullDescription  책소개(일반적인 스펙에는 포함되지 않고, 별도로 요청한 경우에만 협의 후 제공) 문자열 
FullDescription2 출판사 제공 책소개(일반적인 스펙에는 포함되지 않고, 별도로 요청한 경우에만 협의 후 제공) 문자열
subTitle 부제 문자열
originalTitle 원제 문자열
itemPage 상품의 쪽수 숫자
toc 목차 문자열
letslookimg Let's Look(미리보기) 이미지 경로 문자열(URL)
musicinfo < catno 음반 고유의 번호 문자열
musicinfo < recommendationComment 추천글 문자열
dvdinfo < specialFeature Special Feature 문자열
dvdinfo < disc Disc장수 숫자
dvdinfo < playtime 상영시간 문자열
dvdinfo < language 언어 문자열
dvdinfo < caption 자막 문자열
dvdinfo < screenrate 화면비율 문자열
dvdinfo < recordingtype 오디오 문자열
dvdinfo < areacode 지역코드 숫자
(musicinfo, dvdinfo) < authors 참여 아티스트들의 이름 문자열
(musicinfo, dvdinfo) < authors < author << authorType 참여아티스트의 역할 문자열(영문)
(musicinfo, dvdinfo) < authors < author << authorid 참여아티스트의 고유번호 숫자
(musicinfo, dvdinfo) < authors < author << desc authorType에대한 한글 설명 문자열(한글)

 




댓글(0) 먼댓글(0) 좋아요(2)
좋아요
북마크하기찜하기