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)
좋아요
북마크하기찜하기

알라딘 OPEN API 이용은 아래와 같은 절차로 이용할 수 있습니다.

1. 먼저 알라딘 회원 가입 후, TTB가입을 하시고, TTB회원 승인을 기다려주세요. 승인은 보통 신청 후, (업무일 기준)1~2일 가량 소요됩니다. 승인여부는 신청한 웹사이트/블로그를 둘러본 후 승인을 하니 웹사이트/블로그 주소를 정확하게 입력해주세요. 아직 서비스 사이트/앱을 보여줄 단계가 아니라면 따로 ttb@aladin.co.kr로 사용하고자 하는 사이트/서비스를 간략히 소개해주세요. (TTB 가입 :
http://www.aladdin.co.kr/ttb/wjoinus.aspx)

2. 승인이 완료되면 TTB Key값이 발급됩니다.
   TTB Key값은 http://www.aladin.co.kr/ttb/wblog_manage.aspx 이 페이지에서 조회하실 수 있습니다. 
   이 키값은 OPENAPI 키값으로 사용됩니다.

3. 위의 단계만으로도 API 사용이 가능하지만 하루 쿼리 호출수가 5천 건으로 제한됩니다.


4. 개인적인 사용 시에는 이용조건이 없으나, 기업/공공기관에서의 사용하시는 경우  OpenAP와 RSS를 사용하는 조건은 (1) 정보제공이 알라딘에서 되고 있다는 사실을 명시하고 (2) 의미있게 해당 상품의 알라딘 페이지로의 연결이 되어야합니다.
   위의 2가지 조건만 충족을 한다면 알라딘에 가입하신 이메일 / TTB 인증키 / 사이트나 모바일에서 알라딘 로고가 노출 중임을 확인할 수 있는 화면캡쳐 혹은 사이트 주소,앱 이름을 함께 보내주세요. 사용 전에 미리 허락을 득하셔야합니다.

5. 위에 사항과 상관없이 OpenAPI의 호출 일일 5천회를 제휴나 별도 계약으로도 무제한 호출로 제한을 풀어드리고 있습니다. 제휴를 통한 무제한 호출 사용 관련 사항은 marketing@aladin.co.kr 로 해주시면 됩니다.  

6. 기업에서 이용시 OpenAPI로 상품 DB를 호출해서 쓰면서, 알라딘 파트너 프로그램의 파트너코드를 파라메터로 붙여 사용하시면 3% 수익쉐어 됩니다.
파트너 제휴는 marketing@aladin.co.kr
 로 문의 해 주세요.
파트너 코드 예: http://www.aladin.co.kr/shop/wproduct.aspx?ISBN=8992632339&partner=abcpartner


  더 필요하신 사항이나 API기업회원 관련 하여 궁금하신 점이 있으시면 openapi@aladin.co.kr 에 문의해 주세요.



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

예제 파일


  • 아래 파일은 aladdin OpenAPI를 이용한 간단한 프로그램들입니다.

  • C#의 경우는 Full Library를 제공하고, 기타 언어는 간단한 예제를 포함하고 있습니다.

  • 개선사항이나 기타 문제점 발견시 ttb@aladin.co.kr로 연락바랍니다.

개발언어 다운로드 링크 테스트환경
C# [Down] Microsoft.Net Framework 2.0/mono 1.2.5
php [Down] PHP 5.2.4RC1 + Apache 2.2.5.0
java [Down] java 1.6.0
python [Down] python 2.5
ruby [Down] ruby 1.8.6
Power Shell [Down] Power Shell 1.0

 


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





요청 방법


  • 요청 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)
좋아요
북마크하기찜하기

OpenAPI 안내 (최종 수정일 : 2013.6.3)

  • OpenAPI는 알라딘 회원만 이용할 수 있으며, TTB(Thanks to Blogger) 신청 후 알라딘에서 승인한 이후에 이용할 수 있습니다.(TTB신청하기>>)
  • TTB 이용 신청시, OpenAPI를 이용하고자 하는 웹사이트의 주소를 입력해야하며, 미개설/비공개 웹사이트의 경우 일단은 임의의 주소를 입력한 후 ttb@aladin.co.kr로 웹사이트 소개 정보를 별도로 보내주셔야 승인이 이루어집니다(TTB 이용 승인은 1~3일 정도 걸립니다).
  • OpenAPI이용시에는 OpenAPI키값이 필요하며, 이 키값은 등록한 웹사이트 주소에 해당하는 TTBKEY값을 이용하면 됩니다.
  • OpenAPI는 상품검색API(이하 검색API)하나의 상품을 열람하는API(이하 상품API)로 나눠집니다.
  • 상품API는 하나의 상품만을 열람하므로 검색API의 결과보다 자세한 부가 정보가 더해진 결과가 나옵니다.
  • 검색API와 상품API의 결과는 모두 XML형식(기본값), JSON형식(JSON-CallBack방식포함), 확장RSS(OpenSearch)형식으로 받으실 수 있습니다.
  • 요청방식은 GET방식과 POST방식에 상관없이 요청 가능합니다.
  • OpenAPI는 1일 5000회로 제한됩니다. 5000회 이상을 원하시는 분은 ttb@aladin.co.kr으로 연락바랍니다.
  • 분류 ID값은 알라딘 모든 분야 카테고리 엑셀문서를 참고하십시오.
  • 보다 상세한 OpenAPI 매뉴얼은 여기를 참고해주세요.

 



요청 방법


검색 요청(Request) 파라미터 스펙

구분 요청변수 변수종류 설명
필수 TTBKey 문자열 부여받은 TTBKey값
Query 문자열 검색어
옵션
(옵션 조정 변수가 없을 경우에는 기본값으로 검색)
QueryType Keyword (기본값) : 제목+저자
Title : 제목검색
Author : 저자검색
Publisher : 출판사검색
검색어 종류
SearchTarget

Book(기본값) : 도서
foreign : 외국도서
Music : 음반
DVD : DVD
Beauty : 화장품
Gift : 기프트
used : 중고샵(도서/음반/DVD 등) 
Movie : 영화정보 
All : 위의 모든 타겟(몰)

검색 대상 Mall
Start 1이상, 양의 정수(기본값:1) 검색결과 시작페이지
MaxResults 1이상 100이하, 양의 정수(기본값:10) 검색결과 한 페이지당 최대 출력 개수
Sort accuracy : 정확도순(기본값)
PublishTime : 출간일
Title : 제목
SalesPoint : 판매량
CustomerRating 고객평점
MyReviewCount :마이리뷰갯수
정렬순서
Cover Big : 큰 크기
Mid(기본값) : 중간 크기
Small : 작은 크기
Mini : 매우 작은 크기
None : 없음
표지크기
CategoryId 양의정수 - 분야의 고유 번호(기본값:0, 전체)
(참고 : 알라딘 모든 분야 카테고리)
특정 분야로 검색결과를 제한함
Output XML(기본값) : REST XML형식
OS : 확장RSS(OpenSearch방식)
JS : JSON방식
출력방법
Partner 문자 파트너코드. 제휴사의 경우 파트너코드 입력으로 제휴사 유효성 체크.
Omitkey 양의정수(기본값:0) Omitkey가 1인경우 결과링크값에 TTBKey가 제외됨.
InputEncoding 문자열(인코딩의 영문이름 - 기본값:utf-8) 검색어의 인코딩 값을 설정. "utf-8"이나 "euc-kr"과 같은 인코딩의 영문이름.
Version 정수형 날짜
(기본값: 20070901이며 20131101도 가능)
검색API의 Version(날짜형식)을 설정.
20131101의 경우 검색결과 최대 상품수는 200건으로 제약.
CallBack javascript function이름 호출후 불려질 javascript function의 이름을 지정.
output이 js인 경우에 한해 작동됨.
outofStockfilter 품절/절판 등 재고 없는 상품 필터링("1"이 제외 필터) 숫자



검색 응답(Reponse) 결과값 스펙

필드명 설명 자료형
title 조회결과의 제목 문자열
link 조회결과를 확인할 수 있는 Html페이지의 링크 문자열(URL)
language 검색결과의 언어. 무조건 "ko"가 입력됨 문자열
copyright API제공자의 Copyright 문자열
pubDate 조회시간(GMT기준시) 날짜
totalResults 총 검색 결과 개수 정수형
startIndex 현재 페이지 정수형
itemsPerPage 한 페이지당 출력 결과 개수 정수형
query 요청 쿼리 문자열
version 현재 검색API의 Version 정수형 날짜
searchCategoryId 특정 분야로 검색을 제한한 경우 분야의 고유번호 출력 정수형
searchCategoryName 특정 분야로 검색을 제한한 경우 분야의 이름 출력 문자열
ISBN 해당 아이템의 ISBN(10자리) 숫자
ISBN13 해당 아이템의 ISBN(13자리) 숫자
item < itemId 해당 아이템의 고유한 값(알라딘 내부 KEY값) 숫자
item < category
(출력형식 OS에서만 해당)
'알라딘'이 출력 문자열
item < content:encoded
(출력형식 OS에서만 해당)
바로 사용할 수 있는 HTML이 포함된 간략한 상품 설명 문자열
item < description OS 출력형식: HTML이 없는 상품설명
기타 출력형식: HTML이 포함된 간략한 상품 설명
문자열
item < pubDate
item < dc:date
도서 출간일(GMT기준) 날짜
item < dc:creator
(출력형식 OS에서만 해당)
'aladdin'이 출력 문자열
item < priceStandard 상품 정가 숫자(통화)
item < priceSales 알라딘에서 판매하는 판매가(수시로 변동 가능) 숫자(통화)
item < stockStatus 상품의 재고 상태.
재고 보유 상태에서는 특별한 문자도 들어가있지 않으며
품절,절판 등의 특별한 상태일때만 문자열이 출력
문자열
item < mileage 상품 구입시 지급되는 마일리지 숫자(통화)
item < cover 상품 표지 URL 문자열(URL)
item < categoryId 상품 대표 분야의 고유번호(알라딘은 복수 분류체계,그 중 대표 분류 하나)(참고 : 알라딘 모든 분야 카테고리) 숫자
item < categoryName 대표 분류의 상위 분류들(분류 히스토리, "<"를 기준으로 나누어져 있음) 문자열
item < publisher 상품의 출판사(제작사) 문자열
item < customerReviewRank 상품에 대해 고객이 부여한 별점(10점만점) 숫자




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