귓속말^#

Resource^#

account^#

• openid : 사용자의 오픈아이디 / (읽기가능)

1. <accounts type="array">
     <account>
       <openid>http://ias.myid.net/</openid>   
     </account>
   </accounts>

message^#

• id : 메시지 ID / (읽기가능)
• hasRead : 읽었는지 여부 / (읽기가능,쓰기가능)
• starCheck : star 체크 여부 / (읽기가능,쓰기가능)
• from : 메시지 송신자 / (읽기가능,쓰기가능)
• content : 메시지 내용 / (읽기가능,쓰기가능)
• sent-date : 전송 일자 / (읽기가능)

예>  XML 포맷일 경우

1. <messages>
     <message id="120387129847392847" hasRead="yes/no" starCheck="yes/no">
       <from>http://ias.myid.net/</from>
2.     <content><![CDATA[ .... ]]></content>
       <sent-date>yyyy-MM-dd HH:mm:ss</sent-date>
     </message>
     <message id="12033213218930213" hasRead="yes/no" starCheck="yes/no">
       <from>http://ias.myid.net/</from>
       <content><![CDATA[ .... ]]></content>
       <sent-date>yyyy-MM-dd HH:mm:ss</sent-date>
     </message>
   </messages>

URLs^#

account 요청 URL^#

• http://whisper.playmaru.net/account (GET): 계정 유무 조회

  • parameters

    • openid : 사용자의 오픈 아이디 (REQUIRED)

      • 예> http://ias.myid.net/
      • 만약 여러개의 openid에게 동시에 메시지를 보내려면 comma separate 로 입력한다.
      • 예> account?openid=http://ias.myid.net/,http://rath.myid.net/

  1. response

     • <accounts type="array">
         <account>
           <openid>http://ias.myid.net/</openid>   
         </account>
       </accounts>

회원가입 API

• URI(GET) : http://whisper.playmaru.net

• Parameter

  • openid_identifier : 사용자의 openid
  • next_to : 회원 가입 후 돌아올 URL
• 예 : http://whisper.playmaru.net?openid_identifier=http://humbroll.myid.net/&next_to=http://mashupsdev.openmaru.com

messages 요청 URL^#

• http://whisper.playmaru.net/messages/ (GET): 메시지 전체(보낸,받은,혼잣말) 조회

  • parameters

    • has_read : 읽었는지 여부(OPTIONAL) 예> yes, no
    • star_check : star에 체크 여부(OPTIONAL) 예> yes, no
    • since_date : 특정 날짜 이후 메시지 조회를 위한 날짜(OPTIONAL) 예> 2008-4-24 (yyyy-MM-dd)

    • type : 받은메시지(inbox), 보낸메시지(outbox), 혼잣말(selfbox) 예> inbox, outbox, selfbox

      • type 파라미터 대신 URI 부분에 메시지함을 바로 적을 수도 있다.
      • 예> http://whisper.playmaru.net/messages/inbox , http://whisper.playmaru.net/messages/outbox , http://whisper.playmaru.net/messages/selfbox
    • format : 응답 메시지의 형태 (OPTIONAL) 예> xml, json
• http://whisper.playmaru.net/messages (POST): 메시지 전송

• • parameters

    • openid_to : 수신자 (REQUIRED) 예> http://ias.myid.net/
    • content : 내용 (REQUIRED)
• http://whisper.playmaru.net/messages/inbox|outbox|selfbox/m_id (GET): 특정 메시지 조회(m_id : 메시지의 id)

• http://whisper.playmaru.net/messages/inbox|outbox|selfbox/m_id (PUT): 특정 메시지 수정(m_id : 메시지의 id)

  • parameters

    • has_read : 읽었는지 여부(OPTIONAL) 예> yes, no
    • star_check : star 체크 (OPTIONAL) 예> yes, no
• http://whisper.playmaru.net/messages/inbox|outbox|selfbox/m_id (DELETE): 특정 메시지 삭제(m_id : 메시지의 id)

• http://whisper.playmaru.net/messages/inbox (GET): 받은 메시지 조회

  • parameters

    • has_read : 읽었는지 여부(OPTIONAL) 예> yes, no
    • star_check : star에 체크 여부(OPTIONAL) 예> yes, no
    • since_date : 특정 날짜 이후 메시지 조회를 위한 날짜(OPTIONAL) 예> 2008-04-24

• http://whisper.playmaru.net/messages/outbox (GET): 보낸 메시지 조회

  • parameters

    • star_check : star에 체크 여부(OPTIONAL) 예> yes, no
    • since_date : 특정 날짜 이후 메시지 조회를 위한 날짜(OPTIONAL) 예> 2008-04-24

• http://whisper.playmaru.net/messages/selfbox (GET): 혼잣말 조회

  • parameters

    • star_check : star에 체크 여부(OPTIONAL) 예> yes, no
    • since_date : 특정 날짜 이후 메시지 조회를 위한 날짜(OPTIONAL) 예> 2008-04-24

• http://whisper.playmaru.net/messages-with?openid=http://foo.bar.com/

  • parameters

    • openid : 메시지를 주고 받았던 내역을 조회할 상대방의 오픈아이디.
    • format : 응답 메시지의 형태 (OPTIONAL) 예> xml, json