본문 바로 가기
> 검색 API 안내 > 줌 Content API > Content API 매뉴얼

Content API 매뉴얼

1. 요청과 응답

  • 1) 요청

    · REST(Representational State Transfer) 아키텍쳐링 기반으로 디자인 되어 있습니다.
    · 보안을 위해서 HTTPS 요청방식을 사용합니다.
    · REST 각 기능에 따라 GET(조회), POST(생성), PUT(수정), DELETE(삭제) 메소드를 사용합니다. 각 기능에 지정된 메소드만
      사용할 수 있습니다.
    · 응답 포맷은 "Accept" 헤더를 통해서 요청 하고 인코딩은 "UTF-8"을 사용합니다.
    · 모든 요청은 인증을 위해서 줌에서 발급한 Access 토큰을 "Authentication" 헤더에 포함을 시켜야 합니다.

  • 2) 응답

    · 다양한 제휴사 개발 환경을 고려해서 동일한 속성을 갖는 XML 과 JSON 2가지 포맷을 지원 하며, 컨텐츠 피딩을 위한
      API인 경우는 RSS 2.0 Spec(http://cyber.harvard.edu/rss/rss.html)를 준수 합니다.
    · 응답 인코딩은 "UTF-8" 입니다.
    · 날짜 포맷은 "RFC-822 date-time"을(https://www.feedvalidator.org/docs/error/InvalidRFC2822Date.html) 입니다.
    · 응답에 대한 사용 예는 아래와 같습니다.

2. 허브 줌 최신 콘텐츠 조회

  • 1) 요청

    - Description : 허브 줌에서 최신 발행한 콘텐츠 100개
    - URL : GET https://capi.zum.com/hub/contents
    - RSS 지원 여부 : yes
    - Version : 1.0

  • - Headers
    Headers 테이블
    헤더 명 헤더 값 필수
    Accept RSS일 경우
    Accept: application/vnd.zum.resource-1.0+xml;charset=utf-8

    JSON일 경우
    Accept: application/vnd.zum.resource-1.0+json;charset=utf-8
    필수
    Authorization Bearer {Access 토큰} 필수
  • 2) 응답 파라미터
    응답 파라미터 테이블
    파라미터 필수 Type 설명 기본값
    channel 필수 Root 최상위 속성  
    title 필수 String API 명세 허브줌 콘텐츠
    link 필수 String 허브줌 사이트  
    description 필수 String 설명 허브줌 최신 콘텐츠
    language 필수 String 지원언어 ko
    copyright 필수 String 저작권  
    lastBuildDate 필수 String API 요청 시간  
    item[]   Array 콘텐츠 리스트  
    title 필수 String 콘텐츠 제목  
    link 필수 String 콘텐츠 링크  
    author 필수 String 서비스 제공자 help@zuminternet.com (줌인터넷)
    description 필수 String 콘텐츠 설명  
    category 필수 String 카테고리 life: 라이프
    culture: 컬쳐
    trip : 여행
    it: 테크
    food : 푸드
    biz: 비즈
    pubDate 필수 String 콘텐츠 발행일 RFC-822 date-time
    guid 필수 String 콘텐츠 식별자 link 필드와 동일 값
    creator 필수 String 콘텐츠 제공자  
    enclosure   String 콘텐츠 대표 이미지 썸네일 처리 없이 원본 이미지 제공
    url   String 이미지 경로  
    length   String 이미지 사이즈 기본값 1
    type   String 이미지 MINE 타입 application/octet-stream
  • 3) 응답/요청 사용예

    Example : RSS

    GET https://capi.zum.com/hub/contents
    Header
    Accept: application/vnd.zum.resource-1.0+xml;charset=utf-8
    Authorization: Bearer {Access 토큰}
    
    200 OK
    
    
    
    
        허브줌
        <![CDATA[http://hub.zum.com]]></link>
        허브줌 여행
        ko
        <![CDATA[본 콘텐츠의 저작권은 저자 또는 제공처에 있으며, 이를 무단 이용하는 경우 저작권법 등에 따라 법적 책임을 질 수 있습니다.]]>
        Wed, 28 Feb 2018 17:42:23 +0900
        
            <![CDATA[삼엄한 순례자들의 도시, 예루살렘]]>
            <![CDATA[http://hub.zum.com/chaijihyung/17812]]></link>
            help@zuminternet.com (zum)
            <![CDATA[중동의 작은 거인, 성지 순례, 유대인의 고향, IT 강국으로 유명한 나라는? 이스라엘입니다..]]>
            trip
            Sun, 28 Jan 2018 00:00:00 +0900
            <![CDATA[http://hub.zum.com/chaijihyung/17812]]>
            채지형
            
        
        
            <![CDATA[실크로드를 따라 1,200km를 달리다]]>
            <![CDATA[http://hub.zum.com/chaijihyung/17152]]></link>
            help@zuminternet.com (zum)
            <![CDATA[동양과 서양이 만나 새로운 문화를 만들어낸 용광로, 실크로드. 건조한 바람만이 퍽퍽하게..]]>
            trip
            Sun, 28 Jan 2018 00:00:00 +0900
            <![CDATA[http://hub.zum.com/chaijihyung/17152]]>
            채지형
            
         
    
    
    

    Example : JSON

    GET https://capi.zum.com/hub/contents
    Header
    Accept: application/vnd.zum.resource-1.0+json;charset=utf-8
    Authorization: Bearer {Access 토큰}
    
    200 OK
    
    {
        "channel": {
            "title": "허브줌",
            "link": "http://hub.zum.com",
            "description": "허브줌 여행",
            "language": "ko",
            "copyright": "본 콘텐츠의 저작권은 저자 또는 제공처에 있으며, 이를 무단 이용하는 경우 저작권법 등에 따라 법적 책임을 질 수 있습니다.",
            "lastBuildDate": "Wed, 28 Feb 2018 17:42:23 +0900",
            "item": [{
                "title": "삼엄한 순례자들의 도시, 예루살렘",
                "link": "http://hub.zum.com/chaijihyung/17812",
                "author": "help@zuminternet.com (zum)",
                "description": "중동의 작은 거인, 성지 순례, 유대인의 고향, IT 강국으로 유명한 나라는? 이스라엘입니다..",
                "category": "trip",
                "pubDate": "Sun, 28 Jan 2018 00:00:00 +0900",
                "guid": "http://hub.zum.com/chaijihyung/17812",
                "creator": "채지형",
                "enclosure": {
                    "url": "http://static.hubzum.zumst.com/hubzum/2017/12/11/13/eb096f90c9cd4290af9e3eb37b2d38a5.jpg",
                    "length": "405422",
                    "type": "image/jpeg"
                }
            }, {
                "title": "실크로드를 따라 1,200km를 달리다",
                "link": "http://hub.zum.com/chaijihyung/17152",
                "author": "help@zuminternet.com (zum)",
                "description": "동양과 서양이 만나 새로운 문화를 만들어낸 용광로, 실크로드. 건조한 바람만이 퍽퍽하게..",
                "category": "trip",
                "pubDate": "Sun, 28 Jan 2018 00:00:00 +0900",
                "guid": "http://hub.zum.com/chaijihyung/17152",
                "creator": "채지형",
                "enclosure": {
                    "url": "http://static.hubzum.zumst.com/hubzum/2017/11/27/15/12d66e615f9341b7be1450890d76a559.jpg",
                    "length": "181572",
                    "type": "image/jpeg"
                }
            }]
        }
    }
    
  • 4) 응답코드
    응답코드 테이블
    HTTP 상태코드 설명
    401 인증 실패
    404 API가 존재 하지 않거나 지원하지 않는 Version
    422 부적합한 파라미터 또는 필수 값 누락
    500/503 서버에러

3. 허브 줌 카테고리별 최신 콘텐츠 조회

  • 1) 요청

    - Description : 허브 줌에서 최신 발행한 카테고리별 콘텐츠 100개
    - URL : GET https://capi.zum.com/hub/categories/{카테고리 코드}/contents
    - RSS 지원 여부 : yes
    - Version : 1.0

  • - Headers
    Headers 테이블
    헤더 명 헤더 값 필수
    Accept RSS일 경우
    Accept: application/vnd.zum.resource-1.0+xml;charset=utf-8

    JSON일 경우
    Accept: application/vnd.zum.resource-1.0+json;charset=utf-8
    필수
    Authorization Bearer {Access 토큰} 필수
  • 2) 요청 파라미터
    요청 파라미터 테이블
    파라미터 필수 Type 설명
    {카테고리 코드} 필수 String life: 라이프
    culture: 컬쳐
    trip : 여행
    it: 테크
    food : 푸드
    biz: 비즈
  • 3) 응답 파라미터
    응답 파라미터 테이블
    파라미터 필수 Type 설명 기본값
    channel 필수 Root 최상위 속성  
    title 필수 String API 명세 허브줌 콘텐츠
    link 필수 String 허브줌 사이트  
    description 필수 String 설명 허브줌 최신 콘텐츠
    language 필수 String 지원언어 ko
    copyright 필수 String 저작권  
    lastBuildDate 필수 String API 요청 시간  
    item[]   Array 콘텐츠 리스트  
    title 필수 String 콘텐츠 제목  
    link 필수 String 콘텐츠 링크  
    author 필수 String 서비스 제공자 help@zuminternet.com (줌인터넷)
    description 필수 String 콘텐츠 설명  
    category 필수 String 카테고리 life: 라이프
    culture: 컬쳐
    trip : 여행
    it: 테크
    food : 푸드
    biz: 비즈
    pubDate 필수 String 콘텐츠 발행일 RFC-822 date-time
    guid 필수 String 콘텐츠 식별자 link 필드와 동일 값
    creator 필수 String 콘텐츠 제공자  
    enclosure   String 콘텐츠 대표 이미지 썸네일 처리 없이 원본 이미지 제공
    url   String 이미지 경로  
    length   String 이미지 사이즈 기본값 1
    type   String 이미지 MINE 타입 application/octet-stream
  • 4) 응답/요청 사용예

    Example : RSS

    GET https://capi.zum.com/hub/categories/life/contents
    Header
    Accept: application/vnd.zum.resource-1.0+xml;charset=utf-8
    Authorization: Bearer {Access 토큰}
    
    200 OK
    
    
    
    
        허브줌
        <![CDATA[http://hub.zum.com]]></link>
        허브줌 여행
        ko
        <![CDATA[본 콘텐츠의 저작권은 저자 또는 제공처에 있으며, 이를 무단 이용하는 경우 저작권법 등에 따라 법적 책임을 질 수 있습니다.]]>
        Wed, 28 Feb 2018 17:42:23 +0900
        
            <![CDATA[삼엄한 순례자들의 도시, 예루살렘]]>
            <![CDATA[http://hub.zum.com/chaijihyung/17812]]></link>
            help@zuminternet.com (zum)
            <![CDATA[중동의 작은 거인, 성지 순례, 유대인의 고향, IT 강국으로 유명한 나라는? 이스라엘입니다..]]>
            trip
            Sun, 28 Jan 2018 00:00:00 +0900
            <![CDATA[http://hub.zum.com/chaijihyung/17812]]>
            채지형
            
        
        
            <![CDATA[실크로드를 따라 1,200km를 달리다]]>
            <![CDATA[http://hub.zum.com/chaijihyung/17152]]></link>
            help@zuminternet.com (zum)
            <![CDATA[동양과 서양이 만나 새로운 문화를 만들어낸 용광로, 실크로드. 건조한 바람만이 퍽퍽하게..]]>
            trip
            Sun, 28 Jan 2018 00:00:00 +0900
            <![CDATA[http://hub.zum.com/chaijihyung/17152]]>
            채지형
            
         
    
    
    

    Example : JSON

    GET https://capi.zum.com/hub/categories/life/contents
    Header
    Accept: application/vnd.zum.resource-1.0+json;charset=utf-8
    Authorization: Bearer {Access 토큰}
    
    200 OK
    
    {
        "channel": {
            "title": "허브줌",
            "link": "http://hub.zum.com",
            "description": "허브줌 여행",
            "language": "ko",
            "copyright": "본 콘텐츠의 저작권은 저자 또는 제공처에 있으며, 이를 무단 이용하는 경우 저작권법 등에 따라 법적 책임을 질 수 있습니다.",
            "lastBuildDate": "Wed, 28 Feb 2018 17:42:23 +0900",
            "item": [{
                "title": "삼엄한 순례자들의 도시, 예루살렘",
                "link": "http://hub.zum.com/chaijihyung/17812",
                "author": "help@zuminternet.com (zum)",
                "description": "중동의 작은 거인, 성지 순례, 유대인의 고향, IT 강국으로 유명한 나라는? 이스라엘입니다..",
                "category": "trip",
                "pubDate": "Sun, 28 Jan 2018 00:00:00 +0900",
                "guid": "http://hub.zum.com/chaijihyung/17812",
                "creator": "채지형",
                "enclosure": {
                    "url": "http://static.hubzum.zumst.com/hubzum/2017/12/11/13/eb096f90c9cd4290af9e3eb37b2d38a5.jpg",
                    "length": "405422",
                    "type": "image/jpeg"
                }
            }, {
                "title": "실크로드를 따라 1,200km를 달리다",
                "link": "http://hub.zum.com/chaijihyung/17152",
                "author": "help@zuminternet.com (zum)",
                "description": "동양과 서양이 만나 새로운 문화를 만들어낸 용광로, 실크로드. 건조한 바람만이 퍽퍽하게..",
                "category": "trip",
                "pubDate": "Sun, 28 Jan 2018 00:00:00 +0900",
                "guid": "http://hub.zum.com/chaijihyung/17152",
                "creator": "채지형",
                "enclosure": {
                    "url": "http://static.hubzum.zumst.com/hubzum/2017/11/27/15/12d66e615f9341b7be1450890d76a559.jpg",
                    "length": "181572",
                    "type": "image/jpeg"
                }
            }]
        }
    }
    
  • 5) 응답코드
    응답코드 테이블
    HTTP 상태코드 설명
    401 인증 실패
    404 API가 존재 하지 않거나 지원하지 않는 Version
    422 부적합한 파라미터 또는 필수 값 누락
    500/503 서버에러

4. 예제 코드