Page History: 문서 API
Compare Page Revisions
Page Revision: 2018/08/30 17:53
문서 API 안내
문서 API는 웹 기반 요청을 통해 BaroSee 서비스와 통신하는 기능을 제공합니다.
각 요청은 유효한 액세스 토큰과 함께 권한 부여 헤더를 제공해야합니다.
액세스 토큰을 얻는 방법은
Web API 액세스 토큰 를 참고 하세요.
Shared Class(es)
DocumentInfo {Id: string, Name: string, Ext: string, Url: string, TargetFormat: string, [option] Lock: bool, [option] Size: int}
지원되는 기능
- 주의 : 올바른 HttpMethod 사용 하세요
1. 비공개 문서 불러 오기
원본 문서가 삭제되었을 때 사용 합니다.
[HttpPost] /api/document/subscribe
1. 문서 URL 구독 취소
원본 문서가 삭제되었을 때 사용 합니다.
[HttpDelete] /api/document
- Request Header
Authorization: Bearer <access_token> Content-Type: application/json
- Request Data
{ url: <url>, private: bool }
- Response Result
DocumentInfo | Unauthorized | NotFound | BadRequest | Forbidden | UnsupportedMediaType
2. 소스(원본) 문서가 변경되었을 때 알림
원본 문서가 변경 되었을때 사용 합니다.
[HttpPatch] /api/document
3. HTML 기반 형식으로 문서 가져오기
(주의 : 웹사이트 설정에서 HTML로 보기로 설정되어야 함)
[HttpPost] /api/document
예제
붙임 HTML 첨부 파일을 참고 하세요
관련문서
바로씨(BaroSee) 서비스 안내 데모체험