OpenAPI - Data

라이프팟 OpenAPI - Data 문서^#

http://www.lifepod.co.kr/

1. 개요^#

• 라이프팟 Data OpenAPI는 캘린더(일정의 분류) 단위로 XML포맷으로 이용하실 수 있습니다.
• 라이프팟 Data OpenAPI는 별도의 인증이 필요하지 않습니다.
• 제한된 데이터(개인 정보)에 대한 접근은 캘린더마다 할당된 키(암호와 비슷한 일련의 문자열)를 통해서만 할 수 있습니다.
• 공개되지 않은 캘린더의 키는 절대 공개되어서는 안됩니다. 모든 데이터에 접근할 수 있게 되므로 개인정보 유출의 위험이 있습니다.

2. 기본 사항^#

• 라이프팟의 OpenAPI는 HTTP 1.1의 GET method를 이용하여 요청하고 XML문서를 응답받습니다.

• 데이터에 접근하기 위한 URL

  • http://www.lifepod.co.kr/calendar/feed/{개인캘린더ID}.xml
  • 예-한국의 기념일: http://www.lifepod.co.kr/calendar/feed/1.xml
• 정렬은 날짜로 내림차순 정렬 됩니다.

• 기본적으로 50개씩 표시됩니다. 1부터 시작하는 page라는 파라메터를 통해 다음 데이터를 가져올 수 있습니다.

  • 예: 2페이지 보기

    • http://www.lifepod.co.kr/calendar/feed/{개인캘린더ID}.xml?page=2   

  • 예: 10페이지 보기

    • http://www.lifepod.co.kr/calendar/feed/{개인캘린더ID}.xml?page=10

• 기본적으로 표시되는 데이터는 이번달의 데이터 입니다. start, end 파라메터를 통해 이 기간을 조정할 수 있습니다.

  • 예: 2007년 1월부터

    • http://www.lifepod.co.kr/calendar/feed/{개인캘린더ID}.xml?start=2007-01-01

  • 예: 2007년 1월부터 2007년 3월까지

    • http://www.lifepod.co.kr/calendar/feed/{개인캘린더ID}.xml?start=2007-01-01&end=2007-03-01
• 위의 page, start, end 파라메터들을 조합해서 쓸 수 있습니다.

• 위의 세가지 파라메터 외에 공개되지 않은 캘린더(비공개, 선택된 이웃그룹에게 공개, 이웃에게 공개)의 경우 key라는 파라메터가 추가됩니다.

  • http://www.lifepod.co.kr/calendar/feed/{개인캘린더ID}.xml?key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • 이 키는 절대 공개되어서는 안됩니다.

 3. XML 형식^#

• 참고 URL: http://www.lifepod.co.kr/calendar/feed/1.xml
• XML문서에는 크게 캘린더의 정보와 OpenSearch의 정보, 일정의 정보가 포함되어 있습니다.

3-1. 캘린더의 정보^#

• id: XML문서의 ID로 키를 포함한 XML문서 자체의 전체 URL을 의미함
• title: 캘린더의 제목
• subtitle: 캘린더에 대한 설명
• generator: 이 문서의 생성기(Lifepod)

3-2. OpenSearch 정보^#

• openSearch:totalResult: 전체 일정 데이터의 갯수
• openSearch:startIndex: 1부터 시작하는 현재 일정 데이터가 시작하는 지점
• openSearch:itemsPerPage: 한번에 표시될 일정 데이터의 갯수(50개)

3-3. 일정 정보^#

• identifier: 일정 데이터의 ID
• date-modified: 갱신된 시간(UTC 기준)
• date-start: 일정의 시작 시간(UTC 기준)
• date-end: 일정의 끝 시간(UTC 기준)
• title: 제목
• description: 내용

• type: 일정의 종류

  • schedule: 일반 일정
  • daylong: 종일 일정
  • anniversary: 기념일
  • RSS: RSS 항목
  • special: 특수한 일정
• uuid: 이전에 싱크된 데이터의 경우 표시되는 UUID

4. 기타^#

• 쉽게 XML 문서의 링크를 얻는 방법과 키를 변경하는 방법은 아래 그림을 참고하세요.
• 키를 변경할 경우 ICAL(.ics 파일), iCal 발행, HTML 등의 키도 모두 변경됩니다.
•