search

sicamp17-boramsangjo / dear-server

1 stars 1 forks source link

readme

Dear API document

Dear API spec

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

app/createUser

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

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/checkAlreadyJoin

파라미터로 전달된 전화번호로 이미 가입된 사용자가 있는지 검사한다.

Request
property required type format
phoneNumber O string 01D-DDD-DDDD 
curl -i -XPOST indiweb08.cafe24.com:8888/app/checkAlreadyJoin -H 'Content-Type: Application/json' -d '
{
    "phoneNumber": "010-1234-7214"
}
'
Response
property type
result bool 
# Success
{
  "status": 200,
  "msg": "OK",
  "result": true
}

# Failed (Not exist)
{
  "status": 200,
  "msg": "Not exist",
  "result": false
}

app/login

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

Request
property required type
phoneNumber O string
password O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/login -H 'Content-Type: Application/json' -d '
{
    "phoneNumber": "010-1234-7277",
    "password": "sjsj!"
}
'
Response
property type
sessionToken string 
# Success
{
  "status": 200,
  "msg": "OK",
  "sessionToken": "58b0431abf825f7020669fbe"
}

# Failed (Not exist)
{
  "status": 400,
  "msg": "Not exist",
  "user": null
}

# Failed (Password is not matched)
{
  "status": 400,
  "msg": "Password is not matched",
  "user": null
}

app/logout

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

Request
property required type
sessionToken O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/logout -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b0431abf825f7020669fbe"
}
'
Response
property type
resultCode int 
# Success
{
  "status": 200,
  "msg": "OK"
}

# Failed (Not exist)
{
  "status": 400,
  "msg": "Not exist"
}

app/deleteUser

사용자를 탈퇴 처리한다.

Request
property required type
sessionToken O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/deleteUser -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b0431abf825f7020669fbe"
}
'
Response
property type
resultCode int 
# Success
{
  "status": 200,
  "msg": "OK"
}

# Failed (Not exist)
{
  "status": 400,
  "msg": "Not exist"
}

app/updateUserInfo

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

Request
property required type
sessionToken O string
profileImageUrl X string
pushDuration X timestamp
lastLoginAlarmDuration x timestamp 
curl -i -XPOST indiweb08.cafe24.com:8888/app/updateUserInfo -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b10b75bf825f2a27e2ad6f",
    "profileImageUrl": "static/img/profile/test.png",
    "pushDuration": 31536000,
    "lastLoginAlarmDuration": 31536000
}
'
Response
property type
resultCode int 
# Success
{
  "status": 200,
  "msg": "OK"
}

# Failed (Not exist)
{
  "status": 400,
  "msg": "Not exist"
}

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": "58b10b75bf825f2a27e2ad6f"
}
'
Response
property type
result UserInfo 
# Success (신규 유저일 경우, "willitems" 필드는 {} 으로 되어있음.)
{
  "status": 200,
  "msg": "OK",
  "user": {
    "status": "normal",
    "userName": "sjkim",
    "receivers": [],
    "pushDuration": 31536000,
    "lastLoginAlarmDuration": 31536000,
    "todaysQuestion": {
      "questionID": "58b10b70bf825f2a27e2ad6d",
      "deliveredAt": 1487997813
    },
    "profileImageUrl": "static/img/profile/test.png",
    "birthDay": 498841200,
    "phoneNumber": "010-1234-7277",
    "lastLoginTime": 1488001827,
    "willitems": {
      "58b10b70bf825f2a27e2ad6d": {
        "willitemID": "58b10ba0bf825f2a27e2ad70",
        "modifiedAt": 1487997905
      }
    },
    "password": "sjsj!",
    "deviceToken": "",
    "userID": "58b10b75bf825f2a27e2ad6f"
  }
}

# Failed (Not existing user)
{
  "status": 400,
  "msg": "Not exist",
  "user": null
}

유언 받을 사람 관리

app/addReceiver

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

Request
property required type
sessionToken O string
name O string
phoneNumber O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/ -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b1e6adbf825f790eede16d",
    "name": "김순자",
    "phoneNumber": "010-1234-7214"
}
'
Response
property type
resultCode int
receiverID string 
{
  "status": 200,
  "msg": "OK",
  "receiverID": "58b1e6adbf825f790eede16d_3"
}

app/removeReceiver

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

Request
property required type
sessionToken O string
receiverID O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/ -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b1e6adbf825f790eede16d",
    "receiverID": "58b1e6adbf825f790eede16d_1"
}
'
Response
property type
resultCode int 
{
  "status": 200,
  "msg": "OK"
}

app/getReceivers

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

Request
property required type
sessionToken O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/ -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b1e6adbf825f790eede16d",
    "receiverID": "58b1e6adbf825f790eede16d_1"
}
'
Response
property type
receivers [Receiver] 
{
  "status": 200,
  "msg": "OK",
  "receivers": [
    {
      "status": "normal",
      "receiverID": "58b1e6adbf825f790eede16d_0",
      "phoneNumber": "010-1234-7214",
      "name": "홍길동",
      "registeredTime": 1488054058
    },
    {
      "status": "normal",
      "receiverID": "58b1e6adbf825f790eede16d_2",
      "phoneNumber": "010-1234-7214",
      "name": "김순자",
      "registeredTime": 1488054110
    },
    {
      "status": "normal",
      "receiverID": "58b1e6adbf825f790eede16d_3",
      "phoneNumber": "010-1234-7214",
      "name": "김순자",
      "registeredTime": 1488054112
    }
  ]
}

질문 추가 / 조회

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": "58b11c49bf825f2b805f6f04"
}
'
Response
property NonOptional type
questionID O string
text O string
registeredTime O timestamp 
{
  "status": 200,
  "msg": "OK",
  "question": {
    "questionID": "58b11c49bf825f2b805f6f04",
    "text": "현실공간이 비현실적이거나 가상현실처럼 느껴진 적이 있나요?",
    "registeredTime": 1488002121,
    "answered": 0
  }
}

유언 생성/삭제

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": "58b10b70bf825f2a27e2ad6d",
    "deliveredAt": 1487997813,
    "answered": 0
  },
  "willitem": {
    "status": "normal",
    "question": {
      "questionID": "58b10b70bf825f2a27e2ad6d",
      "text": "좋아하는 음식은?"
    },
    "answers": [
      {
        "answerVideo": null,
        "answerText": "사케동도 좋아함",
        "receivers": [],
        "status": "normal",
        "modifiedAt": 1487997905,
        "answerID": "58b10ba0bf825f2a27e2ad70_2",
        "mediaHeight": 128,
        "mediaWidth": null,
        "answerPhoto": null,
        "createdAt": 1487997905
      },
      {
        "answerVideo": null,
        "answerText": "카레카레카레",
        "receivers": [],
        "status": "normal",
        "modifiedAt": 1487997882,
        "answerID": "58b10ba0bf825f2a27e2ad70_1",
        "mediaHeight": null,
        "mediaWidth": null,
        "answerPhoto": null,
        "createdAt": 1487997882
      },
      {
        "answerVideo": null,
        "answerText": "청국장",
        "receivers": [],
        "status": "normal",
        "modifiedAt": 1487997856,
        "answerID": "58b10ba0bf825f2a27e2ad70_0",
        "mediaHeight": null,
        "mediaWidth": null,
        "answerPhoto": null,
        "createdAt": 1487997856
      }
    ],
    "willitemID": "58b10ba0bf825f2a27e2ad70",
    "authorID": "58b10b75bf825f2a27e2ad6f",
    "modifiedAt": 1487997905,
    "createdAt": 1487997856,
    "size": 3
  }
}

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

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

Request
property required type
sessionToken O string
questionID O string
answerText X string
answerPhoto X string
answerVideo X string
mediaWidth X int
mediaHeight X int
receivers X [Receiver]
lastUpdate O timestamp 
curl -i -XPOST indiweb08.cafe24.com:8888/app/createAnswer -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b0431abf825f7020669fbe",
    "questionID": "58b04311bf825f7020669fbd",
    "answerText": "어렸을 때 스파이더맨 보고 나서 그런적 있음."
}
'
Response
property type
willitemID string
anwserID string 
{
  "status": 200,
  "msg": "OK",
  "willitemID": "58b10ba0bf825f2a27e2ad70",
  "answerID": "58b10ba0bf825f2a27e2ad70_3"
}

app/deleteAnswer

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

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

유언 조회

app/getWIllItem

Request
property required type
sessionToken O string
willItemID O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/getWillItem -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b0431abf825f7020669fbe",
    "willitemID": "58b0438ebf825f7020669fbf"
}
'
Response
property type
willitem WillItem 
{
  "status": 200,
  "msg": "OK",
  "willitem": {
    "status": "normal",
    "question": {
      "questionID": "58b10b70bf825f2a27e2ad6d",
      "text": "좋아하는 음식은?"
    },
    "answers": [
      {
        "answerVideo": null,
        "answerText": "kimchi",
        "receivers": [],
        "status": "normal",
        "modifiedAt": 1488002666,
        "answerID": "58b10ba0bf825f2a27e2ad70_3",
        "mediaHeight": 0,
        "mediaWidth": 0,
        "answerPhoto": null,
        "createdAt": 1488002666
      },
      {
        "answerVideo": null,
        "answerText": "사케동도 좋아함",
        "receivers": [],
        "status": "normal",
        "modifiedAt": 1487997905,
        "answerID": "58b10ba0bf825f2a27e2ad70_2",
        "mediaHeight": 128,
        "mediaWidth": null,
        "answerPhoto": null,
        "createdAt": 1487997905
      },
      {
        "answerVideo": null,
        "answerText": "카레카레카레",
        "receivers": [],
        "status": "normal",
        "modifiedAt": 1487997882,
        "answerID": "58b10ba0bf825f2a27e2ad70_1",
        "mediaHeight": null,
        "mediaWidth": null,
        "answerPhoto": null,
        "createdAt": 1487997882
      },
      {
        "answerVideo": null,
        "answerText": "청국장",
        "receivers": [],
        "status": "normal",
        "modifiedAt": 1487997856,
        "answerID": "58b10ba0bf825f2a27e2ad70_0",
        "mediaHeight": null,
        "mediaWidth": null,
        "answerPhoto": null,
        "createdAt": 1487997856
      }
    ],
    "willitemID": "58b10ba0bf825f2a27e2ad70",
    "authorID": "58b10b75bf825f2a27e2ad6f",
    "modifiedAt": 1488002666,
    "createdAt": 1487997856,
    "size": 4
  }
}

app/getWIllItems

Request
property required type
sessionToken O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/getWillItems -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b0431abf825f7020669fbe"
}
'
Response
property type
willitems [WillItem]
size willitem 개수 
{
  "status": 200,
  "msg": "OK",
  "willitems": [
    {
      "status": "normal",
      "question": {
        "questionID": "58b10b70bf825f2a27e2ad6d",
        "text": "좋아하는 음식은?"
      },
      "answers": [
        {
          "answerVideo": null,
          "answerText": "kimchi",
          "receivers": [],
          "status": "normal",
          "modifiedAt": 1488002666,
          "answerID": "58b10ba0bf825f2a27e2ad70_3",
          "mediaHeight": 0,
          "mediaWidth": 0,
          "answerPhoto": null,
          "createdAt": 1488002666
        },
        {
          "answerVideo": null,
          "answerText": "사케동도 좋아함",
          "receivers": [],
          "status": "normal",
          "modifiedAt": 1487997905,
          "answerID": "58b10ba0bf825f2a27e2ad70_2",
          "mediaHeight": 128,
          "mediaWidth": null,
          "answerPhoto": null,
          "createdAt": 1487997905
        },
        {
          "answerVideo": null,
          "answerText": "카레카레카레",
          "receivers": [],
          "status": "normal",
          "modifiedAt": 1487997882,
          "answerID": "58b10ba0bf825f2a27e2ad70_1",
          "mediaHeight": null,
          "mediaWidth": null,
          "answerPhoto": null,
          "createdAt": 1487997882
        },
        {
          "answerVideo": null,
          "answerText": "청국장",
          "receivers": [],
          "status": "normal",
          "modifiedAt": 1487997856,
          "answerID": "58b10ba0bf825f2a27e2ad70_0",
          "mediaHeight": null,
          "mediaWidth": null,
          "answerPhoto": null,
          "createdAt": 1487997856
        }
      ],
      "willitemID": "58b10ba0bf825f2a27e2ad70",
      "authorID": "58b10b75bf825f2a27e2ad6f",
      "modifiedAt": 1488002666,
      "createdAt": 1487997856,
      "size": 4
    }
  ],
  "size": 1
}

app/getWIllItemsWithReceiver

Request
property required type
sessionToken O string
receiverID O string 
curl -i -XPOST indiweb08.cafe24.com:8888/app/getWillItemsWithReceiver -H 'Content-Type: Application/json' -d '
{
    "sessionToken": "58b1e63abf825f790eede16b",
    "receiverID": "58b1e63abf825f790eede16b_0"
}
'
Response
property type
willitems [WillItem]
size willitem 개수 
{
  "status": 200,
  "msg": "OK",
  "willitems": [
    {
      "status": "normal",
      "questionID": "58b1e4b1bf825f790eede165",
      "text": "몇살까지 살고 싶은가요?",
      "answers": [
        {
          "answerVideo": null,
          "answerText": "@임경택 Tag Tag Tag ",
          "receivers": [
            "58b1e63abf825f790eede16b_0"
          ],
          "status": "normal",
          "modifiedAt": 1488064111,
          "answerID": "58b1e7a1bf825f790eede16f_7",
          "mediaHeight": 0,
          "mediaWidth": 0,
          "answerPhoto": null,
          "createdAt": 1488064111
        },
        {
          "answerVideo": null,
          "answerText": "@임경택 hello!!!",
          "receivers": [
            "58b1e63abf825f790eede16b_0"
          ],
          "status": "normal",
          "modifiedAt": 1488063782,
          "answerID": "58b1e7a1bf825f790eede16f_6",
          "mediaHeight": 0,
          "mediaWidth": 0,
          "answerPhoto": null,
          "createdAt": 1488063782
        },
        {
          "answerVideo": null,
          "answerText": "@임경택 니가 좋아 ",
          "receivers": [
            "58b1e63abf825f790eede16b_0"
          ],
          "status": "normal",
          "modifiedAt": 1488060443,
          "answerID": "58b1e7a1bf825f790eede16f_5",
          "mediaHeight": 0,
          "mediaWidth": 0,
          "answerPhoto": null,
          "createdAt": 1488060443
        },
        {
          "answerVideo": null,
          "answerText": "@임경택 good for man!",
          "receivers": [
            "58b1e63abf825f790eede16b_0"
          ],
          "status": "normal",
          "modifiedAt": 1488060294,
          "answerID": "58b1e7a1bf825f790eede16f_4",
          "mediaHeight": 0,
          "mediaWidth": 0,
          "answerPhoto": null,
          "createdAt": 1488060294
        }
      ],
      "willitemID": "58b1e7a1bf825f790eede16f",
      "authorID": "58b1e63abf825f790eede16b",
      "modifiedAt": 1488064111,
      "createdAt": 1488054177,
      "size": 8
    }
  ],
  "size": 1
}

사후에 다른 사람이 유언 읽기

app/getSessionTokenForReadOnly

죽은 사람의 유언을 다른 사람이 읽을 때, 죽은 사람의 유저ID와 생년월일로 죽은 사람의 SessionToken을 얻을 수 있음.

Request
property required type
readOnlyToken O string
birthDay O string(?) integer(?) 
curl -i -XPOST indiweb08.cafe24.com:8888/app/getSessionTokenForReadOnly -H 'Content-Type: Application/json' -d '
{
    "readOnlyToken": "58b159edbf825f3ecc21c691",
    "birthDay": 498841200
}
'
Response
property type
sessionToken string 
{
  "status": 200,
  "msg": "OK",
  "sessionToken": "58b159edbf825f3ecc21c690"
}

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
mediaWidth int
mediaHeight int
lastUpdate timestamp
receiverIDs [receiverID]

Question

property type
questionID string
question string

WIllItem

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