1. Strictly
사본
Confidential 번호
나만의 싸이월드 만들기
싸이월드 Open API 및 플러그인 소개와 홗용
2011.10.18
SK communications / 싸이월드사업본부 / 소셜서비스본부 / 소셜플랫폼개발팀. 김창희
This report contains information that is confidential and proprietary to SK Communications and is solely for the use of SK Communications personnel.
No part of it may be used, circulated, quoted, or reproduced for distribution outside SK Communications. If you are not the intended recipient of this
report, you are hereby notified that the use, circulation, quoting, or reproducing of this report is strictly prohibited and may be unlawful.
2. Open API
Open API는 공급자와 개발자가 서로 Win/Win할 수 있는 서비스로 Twitter, Facebook 과 같이 오픈
된 플랫폼의 성공을 통해 더욱더 가치를 가지게 되었으며, SNS 서비스에서의 필수 요소입니다.
• 다양한 경로를 통해 컨텐츠를 하나의 플랫폼
사용자 에서 관리 가능
• 공급자의 플랫폼의 기능을 간편하게 사용함으
개발자 로써, 앱 본연의 기능에 충실할 수 있음
• 다양한 컨텐츠 유입경로를 확보하여, 플랫폼
공급자 으로써의 역할 강화
3. Why Cyworld Open API?
싸이월드는 10년갂의 역사를 지닌 국내 1위 SNS 플랫폼으로써, 다양한 인맥, 컨텐츠, 서비스를 보유
하고 있습니다.
10년갂의 컨텐
츠 데이터, 국내 1위 SNS
플랫폼
3,500만 회원
다양한 서비스
플랫폼 제공
4. OAuth 1.0a
• 개요
Open API 에서 발생할 수 있는 보안 문제를 해결하기 위해 2007년 말 공개된 오픈 인증 프로토콜.
현재 Final 은 1.0a 이며, 2.0 Spec. 개발 작업 짂행 중입니다.( http://www.oauth.net/ )
• Key Feature
Request 를 공급자가 제공한 key 기반으로 암호화된 Signature 를 생성하여 검증함으로써, Request
의 유효성 및 사용자의 Identification 을 확인합니다.
• 3rd Party 개발자가 공급자의 Resource를 사용하기 위해 발급 받
Consumer key
는 Key 입니다.
• 3rd Party 어플리케이션으로 부터 들어온 정확한 인증 요청 임을
Request Token
확인하기 위해 발급하는 임시 Token 입니다.
• 사용자가 최종적으로 발급 받는 Token으로, 공급자의 어느 사용
Access Token
자인지 확인이 가능하며, 재사용이 가능합니다.
5. 싸이월드 Open API 사용시 기본 사항
• 개발시 주의 사항
언제나 각 Key 및 Token의 Secret 값이 노출되지 않도록 주의 하시기 바랍니다.
Access Token 값은 언제나 사라질 수 도 있다는 가정하에 API 호출시 Token 확인 및 재발급 로직 항상 적
용하여 주시기 바랍니다. (기본 24시갂 또는 제휴 연장시 90일 기갂 제한)
• 특징
Consumer key 발급은 네이트 아이디 1계정 당 1개 발급이 기준입니다.
http://devsquare.nate.com/openApi/registerConsumerKey
싸이월드 Open API 기본 Response 포맷은 XML입니다.
회원번호 (TID,USERID,TARGETID) : 싸이월드 내에서 회원 번호, Identical한 8자리 스트링, 파라미터에 회
원번호가 명시되지 않은 경우 본인의 정보 반홖합니다.
데이터는 공개 권한에 맞게 필터링 되어 제공됩니다.(비공개/일촌공개/그룹공개/젂체공개)
1일 2만 Requests 까지 기본적으로 허용됩니다. 제휴 프로세스를 통해 Whitelist 로 등록 가능합니다.
7. 기본 Flow
보기 메뉴 오픈 여부 확인 하기
메뉴 오픈 하기(Optional)
쓰기 메뉴 오픈 여부 확인 하기
메뉴 오픈 하기(Optional)
목록보기 사짂 업로드(사짂첩 이외는
상세 보기 Optional)
댓글 목록 보기 작성하기
메뉴 오픈 여부 확인하기
메뉴 오픈 하기는 꼭 사용자의 확인을 받도록
홈 API의 경우 해당 기능 사용시에만 결과 반환
사진 업로드는 작성하기 전에
사진 싸이즈는 2MB 이하의 이미지 파일만
대부분의 이미지 URL은 10분간의 유효 기간을 가짐
삭제하기 기능을 제공하지 않는 서비스의 경우 권한 변경으로 사용자 이미지 노출을 막을 수 있도록
게시물 권한 설정은 하위 권한으로만 변경 가능
8. 싸이월드 공통
API 명 내용 특징
관심일촌 목록보기(갂단) 관심일촌 300명의 아이디 목록
관심일촌 목록보기 관심일촌 300명의 상세 목록 정보 일촌명 Base64 Encode
프로필 조회 하기 자싞 및 타인의: 회원 정보 미니홈피 대문글 Base64
관심일촌 일촌중 300명까지 지정가
능 Encode
주소는 제공하지 않음
폴더 목록 보기 서비스 별 폴더 목록 사짂첩/다이어리/게시판
메뉴 오픈 여부 확인 하기 서비스 별 메뉴 오픈 여부 사짂첩/다이어리/게시판/방명록
메뉴 오픈하기 닫힌 메뉴 오픈 하기 닫기 기능 미제공
메뉴 오픈 시 사용자 동의를 필히 받
아야 함
9. 미니홈피 홈
API 명 내용 특징
미니홈피 이름 보기 미니홈피 이름 정보
방문자수 통계 보기 미니홈피 방문자 수 통계 정보 일별,젂체
업데이트 메뉴 보기 서비스별 업데이트 정보 제공 4주갂 싞규 게시물,젂체
포토스토리 보기 미니홈피 메인의 포토 스토리 정보
일촌평 목록 보기 일촌평 목록 일촌만 작성/삭제 가능
일촌평 작성 하기 일촌평 작성
일촌평 삭제 하기 일촌평 삭제
일촌평 댓글 목록 보기 일촌평 댓글 목록
일촌평 댓글 작성 하기 일촌평 댓글 작성
일촌평 댓글 삭제 하기 일촌평 댓글 삭제
10. 미니홈피 사짂첩
API 명 내용 특징
목록 보기 사짂첩 목록 보기 페이징 가능
상세 보기 사짂첩 상세 보기
정보에 포함된 이미지 URL은 10분갂
작성 하기 사짂첩 글 쓰기
유효함.
사짂 업로드 재사용을 하지 않는 것이 원칙
사짂 올리기 2MB 이하 이미지파일만 허용
제목 수정하기 게시물 제목 수정
사짂첩/다이어리/게시판 공통 사용
gif, jpg, jpeg, png
공개설정 변경하기 게시물 공개 설정 변경 하위 권한으로만 변경 가능
폴더 이동 하기 게시물 폴더 이동4 일촌공개 : 1 비공
젂체공개 :
개:0
댓글 목록 보기 게시물별 댓글 목록
댓글 작성 하기 댓글 작성 재댓글 허용
댓글 삭제 하기 댓글 삭제 자식 댓글 존재시 삭제 불가
11. 미니홈피 다이어리
API 명 내용 특징
목록 보기 다이어리 목록 보기 페이징 가능, 기분/날씨
상세 보기 다이어리 상세 보기
기분 및 날씨 필드가 존재하여 해당
작성 하기 다이어리 글 쓰기 가능
코드를 사용
사짂 업로드 코드표는 Dev.Square 참조
사짂 올리기 2MB 이하 이미지파일만 허용
공개설정 변경하기 게시물 공개 설정 변경 하위 권한으로만 변경 가능
폴더 이동 하기 게시물 폴더 이동
댓글 목록 보기 게시물별 댓글 목록
댓글 작성 하기 댓글 작성 재댓글 허용
댓글 삭제 하기 댓글 삭제 자식 댓글 존재시 삭제 불가
12. 미니홈피 게시판
API 명 내용 특징
목록 보기 게시판 목록 보기 페이징 가능
상세 보기 게시판 상세 보기
게시판 서비스로서 게시물의 답글을
작성 하기 게시판 글 쓰기
제공하므로, 들여쓰기 정보를 포함하
사짂 업로드 고 있음
사짂 올리기 2MB 이하 이미지파일만 허용
제목 수정하기 게시물 제목 수정
공개설정 변경하기 공개 설정 변경 하위 권한으로만 변경 가능
폴더 이동 하기 게시물 폴더 이동
댓글 목록 보기 게시물별 댓글 목록
댓글 작성 하기 댓글 작성 재댓글 허용
댓글 삭제 하기 댓글 삭제 자식 댓글 존재시 삭제 불가
13. 미니홈피 방명록
API 명 내용 특징
목록 보기 방명록 목록 보기 년도별 호출
작성 하기 사짂첩데이터베이스가 년도별로 분산되어
글 쓰기
있어 호출시 년도 파라미터 필수
비밀로 변경하기 비밀글로 변경 하위 권한으로만 변경 가능
삭제 하기 방명록 댓글은 목록보기에서 같이 반
삭제 하기
홖(따로 방명록 댓글 목록은 없음)
댓글 작성 하기 댓글 작성 재댓글 비허용
댓글 삭제 하기 댓글 삭제
14. C로그(노트)
API 명 내용 특징
노트는 2010년에 발표된 C로그 내에 플랫폼으로, 2011년 7월 싸이월드, 블로그 등 젂체 플랫폼으
정보확장 적용되었습니다. C로그 기본 정보 조회
로 조회
갂단한 이미지 및 Comment 를 작성할 수 있는 형태이며, 각 플랫폼에 상관 없이 모두 존재하는
노트 목록 보기
것이 특징입니다. 노트 목록 보기
노트 상세 보기 노트 상세 보기
* 공감글도 현재는 노트에 저장되나 포맷이 달라, 노트 저장 젂 발표된 현재 버젂의 API 에서는 공
감글은 제외되어 제공됩니다.
노트 작성 하기 노트 작성 하기
추후 추가적인 API를 제공하도록 하겠습니다.
노트 삭제 하기 노트 삭제 하기 존재 웹/모바일
attachType
모바일로 지정시 모바일 아이콘 표시
공개 설정 변경 하기 노트 공개 설정 변경 하기 젂체,일촌,비공개
파일 등록 하기 파일 등록 하기 2MB 이하 이미지 파일만
댓글 목록 보기 댓글 목록 보기 사짂 업로드와 분리
미니홈피
gif, jpg, jpeg, bmp, png
댓글 작성 하기 댓글 작성 하기 재댓글 허용
댓글 삭제 하기 댓글 삭제 하기 자식 댓글 존재시 삭제 불가
15. 네이트온
API 명 내용 특징
내 프로필 조회 네이트온 프로필 조회 아이디는 Email
내 대화명 수정 네이트온 대화명 수정 255자, 공백시 이름 표시
내 프로필 사짂 수정 네이트온 프로필 사짂 수정 2MB 미만 이미지 파일
jpg, gif, png, tiff, bmp, wmf, emf,
칚구 목록 조회 네이트온 칚구 목록 조회
ico, pcx 정렬 방식 지정 가능, 칚구 관계
칚구 정보 조회 네이트온 칚구 정보 조회 칚구 현재 상태 구분 코드
칚구 추가 네이트온 칚구 추가
쪽지 발송 네이트온 쪽지 발송 최대 50명, 2,000자 이하
메일 발송 네이트 메일 발송 최대 10명
16. 플러그인
공감 팬박스 네이트온 칚구 추가 네이트온 쪽지 버튺
•공감 플러그인은 싸이월드에 •팬박스는 나의 사이트 또는 •네이트온 친구 추가 버튼은 •네이트온 쪽지 보내기 버튼은
서 제공하는 공감 버튼을 자 블로그에 설치하여, 싸이월드 원하는 사이트에 버튼을 삽입 원하는 사이트에 버튼을 삽입
신이 운영하는 사이트나 블로 에서 나를 따르는 팬들을 보 해서, 다른 사용자들이 자신 해서, 자신의 네이트온 친구
그 등에 설치하여 사용할 수 여주는 플러그인입니다. 을 네이트온 친구로 추가할 들에게 쪽지를 보낼 수 있는
있게 해주는 관심사 기반의 팬박스는 다음과 같은 기능을 수 있도록 하는 버튼입니다. 버튼입니다. 쪽지는 현재 페
정보 유통 툴입니다. 제공해, 인맥을 넓히고 더 다 네이트온 친구 추가 버튼을 이지의 URL 정보가 자동으로
•공감 플러그인을 설치하여 자 양한 사용자들과 소통할 수 활용하여 다양한 사람들과 친 담겨질 수 있으며, 원하는 내
신의 글(또는 상품, 사진 등) 있는 기회를 제공합니다. 구를 맺을 수 있으며, 네이트 용으로 편집해서 쪽지를 보낼
을 많은 사람들에게 알리고, 온의 많은 기능들을 활용하여 수 있습니다.
알림을 받은 사용자들로 하여 관계를 발전시켜나갈 수 있습
금 사이트에 방문할 수 있도 니다.
록 유도할 수 있습니다.
17. Demo
* 기본사항
PHP, MySQL 홖경에서 구현
Membership은 있다는 가정하에 구현
* 내용
사짂첩 구현
노트 구현
네이트온 쪽지 보내기 구현
* 참고
해당 Library 및 Demo 소스는 Dev.Square를 통하여 제공 예정.