Cafe Open API는 아래와 같은 API를 가지고 있다.
알림정보
카페의 내 글에 대한 반응, 등업 정보를 제공합니다.
URL
http://apis.daum.net/cafe/alimis.[xml|json]
추가 URL Patterns
없음
Format
- XML
- JSON
HTTP Method
- GET
인증(Authentication)
- OAuth
요청 변수(Request Parameters)
없음
출력 변수(Response Elements)
| 출력변수 | 값 | 설명 |
|---|---|---|
| myAlimis | string | 데이타의 Root Element |
| alimiBbs | item의 리스트 | 내 글에 대한 반응을 제공 |
| alimiUser | item의 리스트 | 내 등급 변경 내용을 제공 |
| item | - | 카페 알림 Element(alimiBbs와 alimiUser에 따라 하위 elelment가 달라짐) |
| cafeName | string | 카페이름 |
| cafeCode | string | 카페 코드(카페 주소에 이용되는 값) |
| alimType | string |
알림의 종류
|
| alimDesc | string | 해당 알림이 추가 설명 |
| boardId | string | 내 글 반응에서 해당 게시글이 속한 게시판 id값 |
| articleId | number | 게시글 id값 |
| articleTitle | string | 내 글 반응에서 해당 게시글의 제목 |
출력 예
<myAlimis>
<alimiBbs>
<item>
<cafeName>사랑해요 Daum카페☆</cafeName>
<cafeCode>ilovedaumcafe</cafeCode>
<alimType>QA_CHOSEN</alimType>
<boardId>AAAA</boardId>
<articleId>1111</articleId>
<articleTitle>[Q 답변이 50개를 넘으면?]에 채택되었습니다. </articleTitle>
</item>
<item>
<cafeName>아이폰뽀개기</cafeName>
<cafeCode>breakiphone</cafeCode>
<alimType>QA_CHOSEN</alimType>
<boardId>AAAA</boardId>
<articleId>11111</articleId>
<articleTitle>[Q 충전이 100% 완료 됐어..]에 채택되었습니다. </articleTitle>
</item>
</alimiBbs>
<alimiUser>
<item>
<cafeName>사랑해요 Daum카페☆</cafeName>
<cafeCode>ilovedaumcafe</cafeCode>
<alimType>LEVEL_UP</alimType>
<alimDesc> 특별회원으로 등업되셨습니다. </alimDesc>
</item>
<item>
<cafeName>사랑해요 Daum카페☆</cafeName>
<cafeCode>ilovedaumcafe</cafeCode>
<alimType>LEVEL_UP_AMDIN</alimType>
<alimDesc> 운영자로 임명되셨습니다. </alimDesc>
</item>
</alimiUser>
</myAlimis>
게시글 리스트 보기
카페의 특정 게시판 게시글 리스트를 제공합니다.
URL
http://apis.daum.net/cafe/articles/{cafeCode}/{boardId}.[xml|json]
URL Patterns
| 이름 | 설명 | 예 |
|---|---|---|
| cafeCode | 카페 code값 | cafe.daum/cafe.aniversary/BdqH |
| boardId | 게시판 ID값 | cafe.daum.net/cafe.anniversary/BdqH |
Format
- XML
- JSON
HTTP Method
- GET
Authentication
- OAuth
요청 변수(Request Parameters)
| 요청변수 | 값 | 설명 |
|---|---|---|
| page | number | 게시글 리스트의 페이지 값 |
출력 변수(Response Elements)
| 출력변수 | 값 | 설명 |
|---|---|---|
| articles | article의 리스트 | articles 데이타의 root element |
| boardId | string | 게시판Id |
| name | string | 게시글 제목 |
| articleId | number | 게시글 번호 |
| userName | string | 작성자 nickname |
| commentCount | number | 댓글 개수 |
| regDateTime | number | 작성일(milliseconds since January 1, 1970, 00:00:00 GMT) |
| viewCount | number | 조회수 |
| hidden | boolean : true, false | 비밀글 여부 (한줄 메모장에 한함) |
출력 예
<articles totalSize="3" totalNewSize="0">
<article>
<boardId>AeyD</boardId>
<name>11주년 기념 이벤트 마감! </name>
<articleId>3</articleId>
<userName>카레</userName>
<commentCount>8</commentCount>
<regDateTime>1276527701000</regDateTime>
<viewCount>141</viewCount>
<hidden>false</hidden>
</article>
<article>
<boardId>AeyD</boardId>
<name>이벤트 참여시 주의 사항 </name>
<articleId>2</articleId>
<userName>카레</userName>
<commentCount>9</commentCount>
<regDateTime>1274615931000</regDateTime>
<viewCount>184</viewCount>
<hidden>false</hidden>
</article>
<article>
<boardId>AeyD</boardId>
<name>[11주년 이벤트] Best11 선발전 이벤트 참여방법 안내</name>
<articleId>1</articleId>
<userName>카레</userName>
<commentCount>4</commentCount>
<regDateTime>1274322701000</regDateTime>
<viewCount>377</viewCount>
<hidden>false</hidden>
</article>
</articles>
게시판 리스트 보기
카페의 게시판 리스트를 제공합니다.
URL
http://apis.daum.net/cafe/boards/{cafeCode}.[xml|json]
URL Patterns
| 이름 | 설명 | 예 |
|---|---|---|
| cafeCode | 카페 code값 | cafe.daum/cafe.aniversary |
Format
- XML
- JSON
HTTP Method
- GET
인증(Authentication)
- OAuth
요청 변수(Request Parameters)
없음
특이사항
- 게시판 목록에는 한줄메모장, 일반게시판, Q&A게시판, 앨범게시판, 폰앨범 게시판, 최신글 보기 게시판만 제공됩니다.
- 운영자 이상의 사용자가 해당 API method 를 호출했을 경우, 감추기 한 게시판도 제공됩니다. (display : false 로 제공됨)
출력 변수(Response Elements)
| 요청변수 | 값 | 설명 |
|---|---|---|
| boards | board의 리스트 | boards 데이타의 root element |
| board | - | 게시판 데이타 속성을 담은 element |
| name | string | 게시판 이름 |
| hasNew | boolean : true, false | 새글 존재 여부 |
| boardType | string | 게시판 타입 |
| display | boolean : true(보임), false(감추기 적용) | 게시판 감추기 여부(관리자 기능) |
| anonymous | boolean : true, false | 익명 게시판 여부 |
출력 예
<boards totalSize="5">
<board boardId="BdqH">
<name>생일축하 게시판</name>
<hasNewChild>true</hasNewChild>
<boardType>BBS</boardType>
<display>true</display>
<anonymous>false</anonymous>
</board>
<board boardId="AeyD">
<name>이벤트 공지사항</name>
<hasNewChild>false</hasNewChild>
<boardType>BBS</boardType>
<display>true</display>
<anonymous>false</anonymous>
</board>
<board boardId="AeyG">
<name>Event1 : 열혈회원 추천</name>
<hasNewChild>false</hasNewChild>
<boardType>BBS</boardType>
<display>true</display>
<anonymous>false</anonymous>
</board>
<board boardId="AeyH">
<name>Event2 : 정모사진 자랑</name>
<hasNewChild>false</hasNewChild>
<boardType>ALBUM</boardType>
<display>true</display>
<anonymous>false</anonymous>
</board>
<board boardId="AeyI">
<name>Event3 : 11글자로 표현</name>
<hasNewChild>false</hasNewChild>
<boardType>MEMO</boardType>
<display>true</display>
<anonymous>false</anonymous>
</board>
</boards>
자주가는 카페 목록 보기
자주가는 카페 목록을 제공합니다.
URL
http://apis.daum.net/cafe/favorite_cafes.[xml|json]
URL Patterns
없음
Format
- XML
- JSON
HTTP Method
- GET
인증(Authentication)
- OAuth
요청 변수(Request Parameters)
없음
출력 변수(Response Elements)
| 출력변수 | 값 | 설명 |
|---|---|---|
| favoriteCafes | cafe 데이타 리스트 | favoriteCafes 데이타의 Root Element |
| cafe | - | cafe element |
| cafeCode | string | 카페 고유 코드 |
| name | string | 카페 이름 |
| updated | boolean : true, false | 새글 존재 여부 |
출력 예
<favoriteCafes>
<cafe>
<cafeCode>CafeLeaders</cafeCode>
<name>Daum카페 리더 모임 - 카리모</name>
<new>true</new>
</cafe>
<cafe>
<cafeCode>breakjob</cafeCode>
<name>.:★:. 취업 뽀개기™ .:★:.</name>
<new>true</new>
</cafe>
<cafe>
<cafeCode>ok1221</cafeCode>
<name>▶[쭉빵카페]A[얼짱비리증거]◀</name>
<new>true</new>
</cafe>
</favoriteCafes>
최신글 보기
카페의 최신 글 리스트를 제공합니다.
URL
http://apis.daum.net/cafe/recent_articles/{cafeCode}.[xml|json]
URL Patterns
| 이름 | 설명 | 예 |
|---|---|---|
| cafeCode | 카페 code 값 | cafe.daum.net/cafe.anniversary |
Format
- XML
- JSON
HTTP Method
- GET
인증(Authentication)
- OAuth
요청 변수(Request Parameters)
| 요청변수 | 값 | 설명 |
|---|---|---|
| page | number | 게시글 리스트의 페이지 값 |
특이사항
- 최신글 보기 데이타는 읽기 권한이 정회원 이항인 일반게시판, 앨범게시판, Q&A 게시판에 한해서 노출 됩니다.
출력 변수(Response Elements)
| 출력변수 | 값 | 설명 |
|---|---|---|
| articles | article의 리스트 | article 데이타의 root element |
| boardId | article의 리스트 | article 데이타의 root element |
| boardName | string | 게시판 이름 |
| name | string | 게시글 제목 |
| articleId | number | 게시글 번호 |
| userName | string | 작성자 nickname(익명인 경우 값 없음) |
| commentCount | number | 댓글 개수 |
| regDateTime | number | 작성일(milliseconds since January 1, 1970, 00:00:00 GMT) |
| viewCount | number | 조회수 |
| hidden | boolean : true, false | 비밀글 여부(한줄 메모장에 한함, 최신글 보기에서는 해당 데이타가 모두 false) |
출력 예
<articles totalSize='928'>
<article>
<boardId>BdqH</boardId>
<boardName>생일축하 게시판</boardName>
<name>안녕 하세요~</name>
<articleId>2</articleId>
<userName>카페유저</userName>
<commentCount>0</commentCount>
<regDateTime>1277135675000</regDateTime>
<viewCount>5</viewCount>
<hidden>false</hidden>
</article>
<article>
<boardId>BdqH</boardId>
<boardName>생일축하 게시판</boardName>
<name>들렀습니다.</name>
<articleId>1</articleId>
<userName>카페유저</userName>
<commentCount>0</commentCount>
<regDateTime>1277134469000</regDateTime>
<viewCount>3</viewCount>
<hidden>false</hidden>
</article>
</articles>
게시글 쓰기 - 한줄메모장
카페에 게시글을 작성합니다. (단, 한 줄 메모장에 한함)
URL
http://apis.daum.net/cafe/write_article/{cafeCode}/{boardId}.[xml|json]
URL Patterns
| 이름 | 설명 | 예 |
|---|---|---|
| cafeCode | 카페 code 값 | cafe.daum.net/cafe.anniversary/BdqH |
| boardId | 게시판 ID 값 | cafe.daum.net/cafe.anniversary/BdqH |
Format
- XML
- JSON
HTTP Method
- GET
- POST
인증(Authentication)
- OAuth
요청 변수(Request Parameters)
| 요청변수 | 값 | 설명 |
|---|---|---|
| content | string : GET Method 제약에 다라 문자열 길이 제한, 또한 한줄 메모장 자체 게시글 사이즈도 적용) | 게시글에 작성할 내용 |
| hideyn | boolean : | 게시글에 작성할 내용 |
특이사항
- content 파라미터 사용할 경우, 해당 데이타를 URLEncoding 해야합니다. 또는 content를 POST로 전송해야 합니다.
- output 값으로는 글쓰기 한 내용이 출력
출력 변수(Response Elements)
| 출력변수 | 값 | 설명 |
|---|---|---|
| article | string | 게시글 데이타의 root element |
| name | string | 게시글 제목 |
| articleId | number | 게시글 번호 |
| userName | 문자열 | 작성자 nickname |
| commentCount | number | 댓글 개수 |
| regDateTime | number | 작성일(milliseconds since January 1, 1970, 00:00:00 GMT) |
| viewCount | number | 조회수 |
| hidden | boolean : true, false | 비밀글 여부(한줄 메모장에 한함) |
출력 예
<article>
<name>게시글 제목</name>
<articleId>74</articleId>
<userName>유저</userName>
<commentCount>0</commentCount>
<regDateTime>1277178500000</regDateTime>
<viewCount>0</viewCount>
<hidden>false</hidden>
<profileImg>http://fimg.daum-img.net/tenth/img/q/l/e/a/1CDYP/66/6e9640.jpg</profileImg>
</article>