스프링노트 REST API

334480 스프링노트 REST API 437835 2008-10-29T09:49:43Z http://dev.springnote.com/pages/334480 2007-06-28T01:58:51Z 스프링노트 REST API 페이지에 오신 것을 환영합니다.   <div>API를 사용하시다 또는 문서를 읽다가 궁금증이 생기면 언제든 <a href="http://ecus-ko.springnote.com/issues" class="external" title="http://ecus-ko.springnote.com/issues">문의/제안</a>을 찾아주시기 바랍니다. 최대한 신속하게 답변 드리겠습니다.</div>   <div id="toc" style="border: 1px solid tan; padding: 2px 10px 0px; background-color: rgb(255, 255, 250);">목차 <hr /> <ol> <li><a href="#toc_0" title="toc_0" class="external">준비 운동</a></li> <li><a href="#toc_1" title="toc_1" class="external">요청</a> <ol> <li><a href="#toc_2" title="toc_2" class="external">인증</a></li> <li><a href="#toc_3" title="toc_3" class="external">리소스 URL</a></li> <li><a href="#toc_4" title="toc_4" class="external">컨텐츠 타입</a></li> <li><a href="#toc_5" title="toc_5" class="external">리소스 파라메터</a></li> </ol> </li> <li><a href="#toc_6" title="toc_6" class="external">리소스</a></li> <li><a href="#toc_7" title="toc_7" class="external">응답</a></li> <li><a href="#toc_8" title="toc_8" class="external">참고 사이트</a></li> </ol> </div>   <h2>준비 운동<a href="#toc_0" title="toc_0" class="anchor" id="toc_0" >#</a></h2> 스프링노트 API를 사용하기 위해서는 아래 내용에 대한 약간의 이해가 필요합니다.   <ul> <li><a href="http://ko.wikipedia.org/wiki/HTTP" title="http://ko.wikipedia.org/wiki/HTTP" class="external">HTTP(S) 프로토콜</a></li> <li><a href="/pages/413660" title="REST" class="wiki">REST 스타일</a></li> <li><a href="/pages/1077552" title="API 센터 개발자 도움말" class="wiki">OAuth 인증</a></li> </ul>   모두 업계에서 사실상 표준으로 인정받는 기술들로, 스프링노트에서도 이를 따르고 있습니다.   <h2>요청<a href="#toc_1" title="toc_1" class="anchor" id="toc_1" >#</a></h2> API 요청은 아래 내용을 담고 있어야 합니다.   <ul> <li>인증 정보</li> <li>리소스 URL</li> <li>컨텐츠 타입</li> <li>HTTP 메서드와 파라메터</li> </ul>   <h3>인증 <a href="#toc_2" title="toc_2" class="anchor" id="toc_2" >#</a></h3> <a href="/pages/1077552" title="API 센터 개발자 도움말" class="wiki">OAuth</a>와 <a href="/pages/413711" class="wiki" title="인증 - OAuth 이전 방식">HTTP 기본 인증 방식</a>을 함께 제공합니다만, OAuth를 사용하실 것을 추천합니다. 보다 자세한 내용은 <a href="/pages/1077552" title="API 센터 개발자 도움말" class="wiki">OAuth</a> 페이지를 참고하세요.   간단히 요약하자면, 특정 사용자의 노트에 접근하기 위해서는 그 사용자의 Acess Token이 필요합니다. <a href="https://api.openmaru.com/mashups/" class="external" title="https://api.openmaru.com/mashups/">오픈마루 API 센터</a>에서 애플리케이션키를 발급받고, 아래 URL을 통해 필요한 토큰을 얻을 수 있습니다. 이 때 보안을 위해 사용자의 동의를 얻는 과정이 필요합니다.   <ul> <li>Request Token URL: <a href="https://api.openmaru.com/oauth/request_token">https://api.openmaru.com/oauth/request_token</a></li> <li>Authorize URL: <a href="https://api.openmaru.com/oauth/authorize">https://api.openmaru.com/oauth/authorize</a></li> <li>Access Token URL: <a href="https://api.openmaru.com/oauth/access_token/springnote">https://api.openmaru.com/oauth/access_token/springnote</a></li> </ul>   <h3>리소스 URL<a href="#toc_3" title="toc_3" class="anchor" id="toc_3" >#</a></h3> 스프링노트에서 제공하는 모든 리소스(<a href="/pages/413747" class="wiki" title="Page 리소스">Page</a>, <a href="/pages/413751" class="wiki" title="Attachment 리소스 ">Attachment</a> 등)는 고유 URL이 부여됩니다. 예를 들어 지금 보고 있는 이 페이지에 대한 정보를 XML 형식으로 얻기 위해서는 아래와 같이 요청합니다.   <img class="attachment" title="Untitled-1.jpg" src="/pages/334480/attachments/901328" alt="Untitled-1.jpg" />   <ol> <li>사용가능한 HTTP 메서드는 리소스에 따라 다릅니다. 예를 들어 <a href="/pages/413747" class="wiki" title="Page 리소스">Page 리소스</a>(/pages/#{id})는 GET/POST/PUT/DELETE를 모두 지원합니다. 하지만 페이지 목록(/pages)은 GET과 POST를 지원하며, PUT/DELETE를 지원하지 않습니다.</li> <li>지원하는 프로토콜은 HTTP와 HTTPS이니, 선택해서 사용할 수 있습니다.</li> <li>API 호출의 경우 모두 api.springnote.com 도메인을 사용합니다.</li> <li>리소스마다 고유 URL이 보여됩니다</li> <li>확장자로 컨텐츠 타입을 지정합니다.</li> <li>접근할 노트의 도메인은 domain 파라메터를 이용해 명시할 수 있습니다. 만일 domain을 생략하면 사용자의 첫번째 개인노트를 의미합니다.</li> </ol>   <h3>컨텐츠 타입<a href="#toc_4" title="toc_4" class="anchor" id="toc_4" >#</a></h3> 스프링노트의 모든 리소스는 XML과 JSON 타입으로 제공됩니다. 그리고 원하는 컨텐츠 타입을 아래와 같은 방법으로 지정할 수 있습니다. (반드시 필요하며, 그렇지 않으면 API 호출로 인정되지 않습니다)   <ul> <li>적당한 확장자를 붙입니다. 즉, 리소스 URL 뒤에 .xml 또는 .json을 붙입니다. (추천)</li> <li>요청의 Content-Type Header를 application/xml 또는 application/json으로 명시합니다.</li> </ul>   요청과 응답의 형식은 항상 일치합니다. 즉, XML로 요청하면 응답은 XML 형식으로 주어집니다.    <h3>리소스 파라메터<a href="#toc_5" title="toc_5" class="anchor" id="toc_5" >#</a></h3> POST나 PUT 메서드로 리소스를 스프링노트로 전송하는 경우 아래와 같이 3가지 방법으로 전달할 수 있습니다.예를 들어 새로운 페이지를 만들려면, 새로 만들 페이지 리소스에 대한 정보를 API에 담아 요청합니다.   <ul> <li> 리소스를 HTTP 요청 파라미터에 속성별로 풀어씁니다. 파라미터 값은 물론 URL 인코딩해야 합니다. 이 때 파라미터명은 리소스명[속성명]으로 적어줍니다(추천). <ul> <li>예) POST http://api.springnote.com/pages.xml?page[title]=NewPage&page[source]=test&page[relation_is_part_of]=1</li> </ul> </li> <li> HTTP 요청 파라메터에 XML이나 JSON 형식으로 포함합니다. 이 때 파라메터명은 xml 또는 json입니다. <ul> <li>예) POST http://api.springnote.com/pages.xml?xml=<page><title>NewPage</title>...</page></li> </ul> </li> <li> HTTP 본문(body)에 넣습니다. 이 때 요청 HTTP 호출의 헤더에 Content-Type을 정확히 명시해야 합니다. 예를 들어, XML이라면 Content-Type이 'application/xml'이어야 하고, JSON이라면 'application/json'이어야 합니다. <ol class="code"> <li>POST <a href="http://api.springnote.com/pages.xml">/pages.xml</a></li> <li>Host: api.springnote.com</li> <li>Header: application/xml</li> <li> </li> <li><page><title>NewPage</title>...</page></li> </ol> </li> </ul>   <h2>리소스<a href="#toc_6" title="toc_6" class="anchor" id="toc_6" >#</a></h2> 스프링노트 API에서 제공하는 리소스는 다음과 같습니다.   <ul> <li> <a href="/pages/413747" title="Page 리소스" class="wiki">Page 리소스</a> <ul> <li><a href="/pages/413751" title="Attachment 리소스 " class="wiki">Attachment 리소스</a></li> <li><a href="/pages/413757" class="wiki" title="Revision 리소스">Revision 리소스</a></li> <li><a href="/pages/413752" class="wiki" title="Lock 리소스">Lock 리소스</a></li> <li><a href="/pages/413763" class="wiki" title="Collaboration 리소스">Collaboration 리소스</a></li> <li><a href="/pages/2003522" class="wiki" title="Comment 리소스">Comment 리소스</a></li> </ul> </li> </ul>   <h2>응답<a href="#toc_7" title="toc_7" class="anchor" id="toc_7" >#</a></h2> 요청이 성공한 경우 200 OK와 함께 상황에 맞는 리소스가 XML 또는 JSON으로 제공됩니다. 만일 에러가 발생하면, 상황에 따른 <a href="/pages/413716" title="응답상태코드">응답 상태 코드</a>와 <a href="/pages/344108" title="에러메시지" class="wiki">에러 메시지</a>가 제공됩니다.   <h2>참고 사이트<a href="#toc_8" title="toc_8" class="anchor" id="toc_8" >#</a></h2> <ul> <li><a href="/pages/438939" title="FAQ" class="wiki">FAQ</a></li> <li><a href="/pages/344045" title="변경 이력" class="wiki">변경 이력</a></li> </ul> <ul> <li><a href="/pages/434279" title="언어별라이브러리" class="wiki">언어별 라이브러리 및 샘플</a></li> <li><a href="http://ecus-ko.springnote.com/issues" class="external" title="http://ecus-ko.springnote.com/issues">스프링노트 문의/제안 게시판</a></li> <li> 매시업 예제 <ul> <li><a href="http://humbroll.springnote.com/pages/7375" class="wiki">험브롤님의 가제트</a></li> <li><a href="http://myruby.net/pages/391476" title="deepblue님의Slugger(오픈소스 프로젝트)">deepblue님의 Slugger (오픈소스 프로젝트)</a></li> </ul> </li> </ul>     deepblue deepblue 293 스프링노트