[Android/Kotlin] 알라딘 API 연동

📌 알라딘 Open API 매뉴얼: https://docs.google.com/document/d/1mX-WxuoGs8Hy-QalhHcvuV17n50uGI2Sg_GHofgiePE/edit

📌 API 키 발급: https://www.aladin.co.kr/ttb/wblog_manage.aspx

 

연동 준비

1. 오픈 API를 사용할 URL 입력 후 추가 버튼 클릭 (블로그 주소 입력해도 됨)

 

2. TTB 키 발급됨

 

코드

DTO

• 검색 결과 전체 저장

data class BookListDTO(
    @SerializedName("item") val books: List<Book>
)

• 검색 결과 중 하나

data class Book(
    @SerializedName("title") val title: String,
    @SerializedName("author") val author: String,
    @SerializedName("description") val description: String,
    @SerializedName("isbn13") val isbn: String,
    @SerializedName("cover") val cover: String,
    @SerializedName("categoryName") val categoryName: String,
    @SerializedName("itemPage") val itemPage: String,
)

 

인터페이스

이 때 공통 url 주소는 http://www.aladin.co.kr/ttb/api/ ==> Retrofit 객체 생성 시 작성

요청 변수는 알라딘 API 문서 확인해 본인한테 필요한 변수 입력하면 됨 (필수 요청 변수는 반드시 입력)

❗ API 버전을 20131101로 해야 상품 리스트 API가 원활하게 작동한다. (기본값: 20070901)
모르고 작업했다가 책 목록이 제대로 안 불러와져서 애먹었음

interface BookService {

    // 알라딘 책 검색 api
    @GET("ItemSearch.aspx")
    suspend fun getBookSearch(
        @Query("TTBKey") ttbkey: String,    // 발급 받은 알라딘 api key 입력
        @Query("Query") query: String,      // 검색어
        @Query("Output") output: String,    // 출력 형식
        @Query("Version") version: String = "20131101"   // api 버전
    ): Response<BookListDTO>

    // 알라딘 책 목록 api
    @GET("ItemList.aspx")
    suspend fun getBookList(
        @Query("TTBKey") ttbkey: String,
        @Query("QueryType") querytype: String,
        @Query("SearchTarget") searchtarget: String,
        @Query("Output") output: String,
        @Query("Version") version: String = "20131101"
    ): Response<BookListDTO>

    // 알라딘 책 상세 api
    @GET("ItemLookUp.aspx")
    suspend fun getBookDetail(
        @Query("TTBKey") ttbkey: String,
        @Query("ItemId") itemid: String,
        @Query("itemIdType") itemidtype: String,
        @Query("Output") output: String,
        @Query("Version") version: String = "20131101"
    ): Response<BookListDTO>

}

 

Retrofit 객체 생성

private val gson = GsonBuilder().setLenient().create()
private val retrofit: Retrofit = Retrofit.Builder()
    .baseUrl("http://www.aladin.co.kr/ttb/api/")
    .addConverterFactory(ScalarsConverterFactory.create())
    .addConverterFactory(GsonConverterFactory.create(gson))
    .build()

val bookService = retrofit.create(BookService::class.java)  // 위에서 작성한 인터페이스

 

함수 작성

인터페이스 작성 시 반환값을 Response로 설정했기 때문에 suspend 사용 (Call로 반환 시 사용할 필요 X)

suspend fun getBookSearch(query: String): List<Book> {
    val bookSearchList = bookService
        .getBookSearch(TTBKEY, query, OUTPUT, VERSION)

    return bookSearchList.body()!!.books
}

suspend fun getBookList(): List<Book> {
    val bookList = bookService
        .getBookList(TTBKEY, QUERY_TYPE, SEARCH_TARGET, OUTPUT, VERSION)

    return bookList.body()!!.books
}

suspend fun getBookDetail(itemid: String): Book {
    val bookDetail = bookService
        .getBookDetail(TTBKEY, itemid, ITEM_ID_TYPE, OUTPUT, VERSION)

    return bookDetail.body()!!.books[0]
}

private companion object{
    private const val TTBKEY = "발급받은 TTB 키"
    private const val QUERY_TYPE = "ItemNewSpecial"
    private const val SEARCH_TARGET = "Book"
    private const val ITEM_ID_TYPE = "ISBN13"
    private const val OUTPUT = "JS"
    private const val VERSION = "20131101"
}

 

함수 사용 시엔 코루틴 사용 (suspend 함수기 때문)

반환 값이 Response기 때문에 Call과 달리 결과값 바로 사용 가능

lifecycleScope.launch {
    val bookList = getBookList()
    binding.bookTitle.text = bookList[0].title
    binding.bookAuthor.text = bookList[0].author
}