/server

Primary LanguagePython

Dear API document

Dear API spec

  • request/response type: application/JSON
  • HTTP method: POST
  • response status
    • 200: 정상 종료
    • 400: 서버는 정상 작동함. but, request를 잘못했거나 request 의도대로 실행할 수 없는 경우
      • 예) 전화번호 포맷이 틀렸다거나, 유저 생성을 하려고 했는데 이미 등록이 되었거나
    • 500: 서버 내부 에러. 서버 담당자에게 연락해야 함.

회원 가입/업데이트/탈퇴

app/createUser

신규 가입하는 회원을 등록한다.

  • 주의사항: 유저를 생성하기 전에 반드시 1개 이상의 등록된 질문이 존재해야 함. (질문등록)
Request
property required type format
userName O string -
phoneNumber O string 01D-DDD-DDDD
password O string -
birthDay O timestamp seconds 
curl -i -XPOST indiweb08.cafe24.com:8888/app/createUser -H 'Content-Type: Application/json' -d '
{
	"userName": "sjkim",
	"phoneNumber": "010-1234-7214",
	"password":	"sjsj!",
	"birthDay": 498841200
}
'
Response
property type
resultCode int 
# Success
{
  "status": 200,
  "msg": "OK",
  "sessionToken": "58ac500abf825f120f773d22"
}

# Failed (Already exist)
{
  "status": 200,
  "msg": "Phone number 010-1234-7214 is already exist",
  "userid": null
}

app/login

기존 회원이 로그인한다. 앱 프로세스 시작시마다 호출되며, 해당 API가 호출될 떄마다 lastLoginTime이 갱신된다.

Request
property required type
phoneNumber O string
password O string
Response
property type
sessionToken string

app/logout

명시적으로 로그아웃 처리한다. 서버에서는 DeviceToken을 삭제하고 더이상 Push를 보내지 않으며, 사망 체크도 중단한다.

Request
property required type
sessionToken O string
Response
property type
resultCode int

app/deleteUser

사용자를 탈퇴 처리한다.

Request
property required type
sessionToken O string
Response
property type
resultCode int

app/updateUserInfo

사용자 정보 중 일부를 업데이트한다.

Request
property required type
sessionToken O string
profileImageUrl X string
pushDuration X timestamp
lastLoginAlarmDuration x timestamp
Response
property type
resultCode int

app/getUserInfo

현재 로그인된 사용자 정보를 불러온다.

Request
property required type
sessionToken O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/getUserInfo -H 'Content-Type: Application/json' -d '
{
	"sessionToken": "58ac500abf825f120f773d22"
}
'
Response
property type
result UserInfo 
# Success
{
  "status": 200,
  "msg": "OK",
  "user": {
    "userName": "sjkim",
    "_id": "58ae628ebf825f4bb046dd24",
    "receivers": [],
    "pushDuration": 31536000,
    "todaysQuestion": {
      "questionId": "58ac500abf825f120f773d22",
      "deliveredAt": 1487823502
    },
    "profileImageUrl": "",
    "birthDay": 49881200,
    "phoneNumber": "011-1274-5313",
    "lastLoginTime": 1487823502,
    "willitems": {},
    "password": "sjsj!",
    "deviceToken": ""
  }
}

# Not existing user
{
  "status": 200,
  "msg": "Not exist",
  "user": null
}

유언 받을 사람 관리

app/addReceiver

사망시 SMS를 받을 대상자를 추가한다.

Request
property required type
sessionToken O string
name O string
phoneNumber O string
Response
property type
resultCode int
receiverID string

app/removeReceiver

사망시 SMS를 받을 대상자를 제거한다.

Request
property required type
sessionToken O string
receiverID O string
Response
property type
resultCode int

app/getReceivers

사망시 SMS를 받을 대상자 리스트를 불러온다.

Request
property required type
sessionToken O string
Response
property type
receivers [Receiver]

질문 추가 / 조회

app/addQuestion

Request
property required type
text O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/addQuestion -H 'Content-Type: Application/json' -d '
{
  "text": "현실공간이 비현실적이거나 가상현실처럼 느껴진 적이 있나요?"
}
'
Response
property NonOptional type
questionId O string 
{
  "status": 200,
  "msg": "OK",
  "questionId": "58adbae4bf825f3ceca53ca6"
}

app/getQuestion

Request
property required type
questionId O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/getQuestion -H 'Content-Type: Application/json' -d '
{
	"questionId": "58adb8b2bf825f3c04f4d319"
}
'
Response
property NonOptional type
questionId O string 
{
  "status": 200,
  "msg": "OK",
  "question": {
    "answered": 0,
    "_id": "58adb8b2bf825f3c04f4d319",
    "question": "현실공간이 비현실적이거나 가상현실처럼 느껴진 적이 있나요?",
    "registeredTime": 1487780018
  }
}

유언 생성/삭제

app/getTodaysQuestion

Request
property required type
sessionToken O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/getTodaysQuestion -H 'Content-Type: Application/json' -d '
{
  "sessionToken": "58ae628ebf825f4bb046dd24"
}
'
Response
property NonOptional type
question O Question
willItem X WillItem 
{
  "status": 200,
  "msg": "OK",
  "question": {
    "text": "현실공간이 비현실적이거나 가상현실처럼 느껴진 적이 있나요?",
    "questionId": "58ae5b08bf825f489ae9ff86",
    "deliveredAt": 1487823502,
    "answered": 0
  }
}

app/uploadImage

이미지 파일을 멀티파트로 업로드한다.

Request
property required type
imageData O multipart
Response
property type
url string

app/uploadVideo

동영상 파일을 멀티파트로 업로드한다.

Request
property required type
videoData O multipart
Response
property type
url string

app/createAnswer

유언 질문에 대한 답변을 생성한다.

  • 유저가 이미 답변했던 질문이면 그 전에 만들어졌던 willitem에 추가함.
  • 전에 답변한적 없는 질문이면 새로운 willitem이 만들어짐. willitemID는 questionID와 동일함.
Request
property required type
sessionToken O string
questionID O string
answerText X string
answerPhoto X string
answerVideo X string
receivers X [Receiver]
lastUpdate O timestamp
Response
property type
anwserID string

app/deleteAnswer

이미 생성되어있는 답변을 삭제한다.

Request
property required type
sessionToken O string
questionID O string
anwserID O string
Response
property type
resultCode int

유언 조회

getWIllItems

Request
property required type
sessionToken O string
Response
property type
results [WillItem]

getWIllItem

Request
property required type
sessionToken O string
willItemID O string
Response
property type
result WillItem

Response model

User

property type
userName string
phoneNumber string
birthDay timestamp
deviceToken string
profileImageUrl string
pushDuration timestamp
todaysQuestionID string
todaysQuestionSetTime timestamp
lastLoginAlarmDuration timestamp
receivers [Receiver]

Receiver

property type
receiverID string
name string
phoneNumber string

Answer

property type
anwserID string
answerText string
answerPhoto string
anwserVideo string
lastUpdate timestamp
receiverIDs [receiverID]

Question

property type
questionID string
question string

WIllItem

property type
willItemID string
questionID string
question string
anwsers [Answer]
lastUpdate timestamp