SOAPS (Site Open API PHP Server)

[*] Site Open API

문서: 배포 문서
명칭: SOAPS (Site Open API PHP Server)
버젼: 0.8
용도: 사이트(홈페이지)의 Open API 기능을 제공.
작성: 더카이 (ky, thruthesky)
연락: thruthesky@yahoo.co.kr http://jangnans.com http://siteapi.kldp.net
요약: Site Open API 는 여러분의 홈페이지에 멋진 Open API 를 제공할 것입니다. 본 배포물은 Site Open API 규격 전체를 구현한 PHP 버젼 XML-RPC 서버 소스 스크립트(이하 본 소프트웨어)를 포함합니다. 따라서 기존 내용에서 추가된 메소드 리스트는 Site Open API(http://siteapi.kldp.net) 규격을 참조 하십시오.
참조: 빌드가이드.txt http://jangnans.com http://siteapi.kldp.net http://xmlrpc.com, Site Open API 활용법
기능: Site Open API 의 기능과 동일

[*] Site Open API 란

Open API 라는 용어가 이 골목 저 골목 흘러다니고 있습니다. Web 2.0 이니 뭐니 하면서 신경쓰이게 합니다. 아주 관심없이 그냥 지나쳐 버리는 분도 있습니다. 부담스럽고 어려워서 관심없는 척 못들은 척 하는 분도 계십니다. 그냥 넘어가자고 설득하지는 분들도 계십니다.
대형 웹 서비스 업체들은 자사이트의 Open API 를 경쟁적으로 홍보합니다.
Open API 에 표준이 있습니까? 당연히 있겠죠. 인터넷 표준 규격을 제정하는 곳에서 표준 문서를 찾으면 서너장쯤 나올만 합니다.
Open API 란... 사이트(홈페이지)의 유용한 정보(또는 기능)을 사이트 외부(사이트에 접속 하지 않은 상태)에서 사용을 할 수 있게 해 주는 통로(기능, 툴, Gateway)와 같은 것입니다. 한 예를 들자면 MS 워드 프로세서나 한글, 나모 웹에디터 등에서 문서를 편집한 뒤에 바로 게시판에 글을 올리는 것이 있습니다. FTP 로 서버에 HTML 파일을 올리는 것이 아니라, 게시판에 사진과 글을 직접 올리고 편집하고 하는 것입니다. 그냥 웹 브라우저로 게시판에 글을 올리면 되지 뭐하러 편집기를 쓰느냐 라고 반문하시면 재미없습니다. 이것은 한 예일 뿐, 실제로 Open API 를 통해서 할 수 있는 일들은 제한 적이지 않습니다. Open API 는 HTTP 바탕에서 이루어지며 HTTP 가 할 수 있는 많은 것들을 할 수 있습니다.
Site Open API 는 여러분의 홈페이지에 강력한 Open API 를 제공할 규격입니다. Open API 는 더 이상 야후나 다음, 네이버와 같은 대형 서비스 업체의 전유물이 아닙니다.
Site Open API 를 통해서 홈페이지의 정보를 실시간으로 감시(모니터링, 확인)할 수 있으며 수 많은 웹 편집기로 직접 글을 올릴 수 있습니다. 물론 이러한 기능은 홈페이지 관리자가 아닌 홈페이지 사용자가 직접 이용할 수 있는 서비스입니다.
Site Open API 에는 Blogger API, Meta Weblog API 가 포함이 됩니다. 따라서 Site Open API 서비스를 한다는 것은 이러한 Open API 만 완전히 독립적으로 사용이 가능하다는 것을 의미합니다. Site Open API 는 기존의 Open API 보다 훨씬 넓은 개념입니다.
자세한 내용은 http://siteapi.kldp.net 을 참조하십시오.
Site Open API 활용법 문서: http://jangnans.com/?cate=bbs&mode=read&idx=295


[-] Site Open API 특징:
+ 대형 사이트 뿐만 아니라 중/소 형 홈페이지를 위한 메소드 규격
+ Blogger API 포함
+ MetaWeblog API 포함


[*] Site Open API 클라이언트
Site Open API 가 사이트(홈페이지,웹 서버)에 설치되었다면, Site Open API 클라이언트를 통해서 홈페이지 정보 이용이 가능합니다. 다시말하면, 자신의 홈페이지에 가입된 회원(비 회원 가능)이 아래의 소프트웨어들을 통해서 아주 편리하게 자신의 홈페이지 정보를 활용할 수 있다는 것입니다.
Site Open API 클라이언트는 무궁 무진합니다. 웹브라우저가 그 좋은 하나의 예입니다. 지금도 수 없이 만들어 지고 있습니다.
+ 추천 Site Open API 클라이언트
++ Site Open API 전용 클라이언트 '사이팅' - 실시간 홈페이지 새 정보 모니터링 툴
++ PHP 로 직접 Site Open API 클라이언트를 작성 가능 ( siteapi.kldp.net 참조 )
++ 원격 블로그 편집기:
거의 모든 '원격 블로그 편집기' 가능합니다. 원격 블로그 편집기가 Site Open API 를 만난다면, 블로그 뿐만 아니라 사이트내의 게시물과 같은 정보를 직접 작성(변경)이 가능합니다.

+++ Microsoft Windows 사의 라이브 라이터(Live Writer) - 블로그 편집기
+++ 멀티 블로깅 편집기 '장난' - 한번의 포스팅으로 수십 수백개의 블로그에 글이 포스팅 됨. 여러개 글 삭제 기능 지원
+++ Zoundry 블로그 Writer (http://www.zoundry.com/download.html)
+++ MS Word 2007
+++ 나모웹에디터
+++ Mozila 의 Firefox Add-on Performancing - 웹브라우저에서 응용 프로그램 형식의 내부 편집기
+++ 기타, 문서 'Site Open API 활용법' 를 참고하십시오. 더 많은 정보를 얻을 수 있습니다.


[*] Site Open API 서버

서버 프로그램은 홈페이지(웹서버)에 설치되어 실행이됩니다.
홈페이지 정보를 Site Open API 규격에 맞게 조정 작업을 해야합니다.
SOAPS 버젼 0.6 현제 제로보드4, 제로보드5, 그누보드4, 장난 홈툴즈, rgboard 로 작성된 홈페이지에 데이터 규격 조정 작업이 진행되어 있으며 이를 통해 운용하는 홈페이지는 바로 사용이 가능합니다. 손에 잡히는 것 부터 먼저 작업을 했습니다. 얼마든지 다른 홈페이지 프로그램에 추가가 가능합니다.

아래의 설치형 홈페이지 정보 관리 소프트웨어들은 SOA-PS version 0.3 을 설치해야합니다.
(버젼 0.3 에서 0.6 까지 변동이 없으며, 0.6 에서 테스트가 이루어지지 않았습니다.)
+ 제로보드4 - http://nzeo.com
+ 제로보드5 - http://zeroboard.com
+ 그누보드4 - http://sir.co.kr
+ 미니 - http://thruthesky.webzero.co.kr/etc/mini
아래의 설치형 홈페이지 정보 관리 소프트웨어들은 SOA-PS version 0.6 를 설치해야합니다.
+ 장난 홈툴즈 - http://thruthesky.webzero.co.kr/etc/jangnan/
+ 알지보드 3.2.1 - http://rgboard.com
SOAPS 버젼 0.8 부터는 포팅한(사용가능한) 소프트웨어를 목록하지 않습니다. 자신의 홈페이지에서 사용가능한지는 SOAPS 홈페이지를 참고하시고, 필요한 경우 직접 자신의 홈페이지 정보를 SOA 규격에 맞도록 조정을 하는 스크립트를 작성하셔야합니다.

기타: 설치가 가능한 '홈페이지 정보 관리 툴' (CGI 프로그램) 에 본 소프트웨어를 추가하려면 정보를 관리하는 데이터의 규격만 Site Open API 의 것과 맞추면됩니다. 홈페이지 게시판 관련 툴 전체를 본인이 직접 모두 포팅을 하기에 많은 시간이 소모됩니다. 개발자에게 도움을 요청 해 봤지만 비협조적이라는 느낌을 받아 아쉬운 점이 많았습니다. 혼자서 많은 홈페이지 프로그램에 Site Open API 기능을 추가시키기가 쉽지 않습니다. Site Open API 에 관심이 있는 홈페이지 프로그램 개발자와 연락이 닿는다면 꼭 같이 진행을 해 보고 싶습니다.



[*] 설치

설치는 간단합니다. PHP 스크립트를 적당한 위치에 업로드하는 것으로 설치는 끝납니다.

본 소프트웨어는 사이트(홈페이지, 웹서버)에 설치되는 Site Open API 규격을 구현한 결과물로서 PHP 언어로 작성되어있습니다.
본 소프트웨어(현제 압축 파일에 포함되어 배포되는 프로그램)의 현재 버젼에서 지원하는 '설치형 홈페이지 정보 관리 툴'은 본 문서의 다른 항목에 기술되어 있습니다. 정확한 정보는 관련 홈페이지를 참고하십시오.

현제 지원하지 않는 툴로 운영되는 홈페이지는 'Site Open API 규격에 맞는 정보의 조정' 작업이 필요합니다. 이와 관련된 내용은 http://siteapi.kldp.net 을 참고하기 바랍니다.

-1 설치하려는 사이트에 본 소프트웨어가 지원하는지 확인합니다. (그렇지 않다면, 직접 데이터 조정 작업을 거쳐야합니다.)
-2 본 소프트웨어의 압축물을 압축해제 후 홈페이지에 저장(업로드)합니다.
홈페이지에 저장을 할 때에는 디렉토리 이름이 반드시 'siteapi' 이어야합니다.
예를 들면, http://jangnans.com 이 홈페이지 주소라면, http://jangnans.com/siteapi/ 위치에 설치를 해야한다. 만약 홈페이지 주소가 http://site.com/tool/ 이라면 http://site.com/tool/siteapi/ 에 설치가 되어야합니다.
이것은 Site Open API 에서 공통적으로 이행하는 하나의 약속입니다.
PHP 스크립트를 홈페이지 계정(웹서버 계정)의 적당한 디렉토리에 업로드하는 것으로 설치는 끝납니다.
-3 설치(업로드)가 올바로 되었는지 확인을 하기 위해서는 업로드된 디렉토리로 웹브라우저를 통해 접속을 해 본다. (예, http://jangnans.com/siteapi/ 실제로 접속을 해서 어떤 결과가 나타는지 확인을 해 보기 바랍니다.)
-4 독립 Open API 활용을 위한 처리
Blogger API, Meta Weblog API 등의 Open API 는 Site Open API 에 속해있지만, 그것 자체만으로도 완전히 독립된 API 들입니다. 실제 예로 Blogger API 만으로 Zoundry 를 통해서 홈페이지에 글을 게제할 수 있습니다. 이러한 Open API 서비스를 위해서 EndPoint 자동 검출 링크를 스킨에 기록(자세한 정보는 http://siteapi.com 이나 http://jangnans.com 을 참고)

[*] 설치형 홈페이지 정보 관리 소프트웨어별 특징.
[-] 제로보드 5
SOA 버젼 0.12 까지 구현이 되어있습니다.
[-] 제로보드 4
SOA 버젼 0.4 까지 구현이 되어있습니다.
zb4 는 하나의 게시물에 2개 까지 첨부 파일을 허용합니다. 이것은 metaWeblog.newMediaObject 와의 규칙이 어긋납니다. 따라서 metaWeblog.newMediaObject 는 SOA 규격에 의한 방법으로 첨부 파일을 보관합니다. 첨부 파일의 보관 장소, 파일 명칭의 형식은 SOA 규격 문서를 참조하십시오.
[-] 알지보드
SOA 버젼 0.12 까지 구현이 되어 있습니다.
[-] 그누보드
SOA 버젼 0.4.4 까지 구현이 되어 있습니다.
원격 편집을 할때, 글 관련(첨부 파일 업/다운 등 포함) 포인트 조정은 안됩니다. 글 관련 작업 처리를 포팅하는 과정이 쉽지않아 포인트 정보 관련 업데이트 부분은 생략을 하였습니다. siteapi_datalayer_functions.php::dl_newPost/editPost 에서 관련 코드를 확인할 수 있습니다.
게시판 설정에 파일 업로드 개수 제한 옵션이 있습니다. 원격 편집에서 등록 가능한 이미지의 개수를 제한하는 것은 의미가 없으므로, 설정의 옵션을 무시합니다.
[-] 미니툴
SOA 버젼 0.12 까지 구현을 하였습니다. SOAPS 개발자가 더 이상 지원을 하지 않는 소프트웨어입니다.
[-] 장난-홈툴즈
SOA 버젼 0.4 까지 구현이 되어있습니다.




[*] 기타
[-] 클라이언트
아래는 오직 SOA 만을 위한 클라이언트(들)입니다. 다른 API 서버에서는 동작하지 않습니다.
- SOAPS 가 올바로 설치 되었으면 '사이팅'을 통해서 홈페이지 정보를 실시간으로 확인(감시)할 수 있습니다.
실시간 홈페이지 정보 관리 툴 '사이팅'은 http://jangnans.com 에서 다운로드할 수 있습니다.
사이팅' 외에 필요한 기능이 있으면 http://siteapi.kldp.net 으로 연락바랍니다.

[-] 홈페이지 API 주소(End Point, 웹 서버 Open API 주소)

API 주소는 기본적으로 siteapi 디렉토리까지 기록을 하면된다.
예를 들면 http://jangnas.com/siteapi/ 이다. 디렉토리까지만 기록을 하면, 웹서버의 디렉토리 인덱싱 기능을 해서 자동으로 index.html 이나 index.php, index.asp, index.cgi 등이 실행될 것이다. http://jangnans.com/siteapi 와 같이 디렉토리 마지막에 / 를 붙이지 않아도 되는 경우가 있다. 이것은 전적으로 웹서버에 의존하며, 되도록 / 를 디렉토리 맨 마지막에 표시하기를 권장한다.

다음은 몇가지 가능한 siteapi 주소 예입니다.
ex)
http://jangnans.com/siteapi/
http://localhost/homepage/jangnan/siteapi/
http://yourdomain.co.kr/yourhomepagepath/siteapi/index.php

[*] SOAPS 의 달라진 점 기록
2007/01/03 클라이언트로 전송하는 XML 데이터의 문자셋을 utf-8 로 고정시킨다. 이것은 <?xml version="1.0" encoding="utf-8"?> 와 같이 문자셋의 표현을 고정시키는 것이다. 자세한 것은 규격 문서를 참고한다.