volume : Volume Server Api

https://volume-server-api.herokuapp.com

REST API

Korean API Doucment

1. 회원 가입

1-1. 중복 확인

2. 로그인

3. 프로필 사진 업로드

4. 프로필 사진 다운로드

5. 배경 사진 업로드

6. 배경 사진 다운로드

7. 회원 정보 수정

8. 음악 업로드

---

---

회원 가입

• URL : "/api/signup"

• Method : POST

Request

{   "id" : "testerid",
    "password" : "testpassword",
    "userName" : "tester",
    "email" : "test@volume.co.kr",
    "kakao" : false}

• kakao 연동으로 회원가입 시 : kakao 값을 true로 한 뒤, password는 입력하지 않아도 됨
• 일반 회원가입 시 : kakao 값을 false로 하거나 사용하지 않고, password는 필수임

Response

{   "id" : "testerid"}

---

중복 확인

• URL : "/api/signup/checkDuplication"

• Method : POST

Email 중복 확인

Request

{
    "email" : "test"
}

• Email 중복 확인 시, email만 body로 넘긴다.

Response

{
    "exist": false,     //true (이미 해당 이메일이 사용중), false (해당 이메일이 사용중이지 않음 => 사용할 수 있음)
    "type": "EMAIL",    //이메일 중복 확인 요청했음
    "id": null,         //이메일 중복 확인 요청 시, 아이디는 넘어온게 없으므로 null
    "email": "test"     //중복 확인 된 이메일
}

Id 중복 확인

Request

{
    "id" : "tester12"
}

• id 중복 확인 시, id만 body로 넘긴다.

Response

{
    "exist": false,     //true (이미 해당 아이디가 사용중), false (해당 아이디가 사용중이지 않음 => 사용할 수 있음)
    "type": "ID",       //아이디 중복 확인 요청했음
    "id": "tester12",   //중복 확인 된 아이디
    "email": null       //아이디 중복 확인 요청 시, 이메일는 넘어온게 없으므로 null
}

---

로그인

• URL : "/api/login"

• Method : POST

Request

{   "id" : "testerid",
    "password" : "testpassword"}

Response

{   "id" : "testerid"}

---

프로필 사진 업로드

• URL : "/api/uploadProfilePic"

• Method : POST

Request

{   "id" : "testerid",
    "profilePic" : 파일 }

Response

{   "id" : "testerid"}

---

프로필 사진 다운로드

• URL : "/api/getProfilePic"

• Method : GET

Request

{   "id" : "testerid" }

Response

파일

---

배경 사진 업로드

• URL : "/api/uploadBackgroundPics"

• Method : POST

Request

{   "id" : "testerid",
    "profilePic" : 파일 }

Response

{   "id" : "testerid"}

---

배경 사진 다운로드

• URL : "/api/getBackgroundPics"

• Method : GET

Request

{   "id" : "testerid" }

Response

파일

---

회원 정보 수정

아직 서버 업로드 안됨

• URL : "/api/updateUser"

• Method : PATCH

Request

{
    "id" : "tester1",
    "password" : "password1",
    "newPassword" : "1234",
    "userName" : "TestUpdate",
    "email" : "update@email.com"
}

Response

{   "id" : "testerid"}

---

음악 업로드

• URL : "/api/uploadMusic

• Method : POST

Request

{   
    "userId" : "testerId",
    "title" : "testMusic",
    "musicFilePath" : 파일 
}

Response

{   
    "id" : "testMusicId",
    "title" : "testMusicTitle" 
}

---

English API Document

1. Sign up

1-1. Check Duplication

2. Login

3. Upload Profile Picture

4. Get Profile Picture

5. Upload Background Picture

6. Get Background Picture

7. Modify User Information

8. Upload Music

---

---

Sign Up

• URL : "/api/signup"

• Method : POST

Request

{   "id" : "testerid",
    "password" : "testpassword",
    "userName" : "tester",
    "email" : "test@volume.co.kr",
    "kakao" : false}

• Login with Kakao : The value of kakao is true and password is not required
• General Login : The value of kakao is false or not used, and the password is required.

Response

{   "id" : "testerid"}

---

Check Duplication

• URL : "/api/signup/checkDuplication"

• Method : POST

Check Email Duplication

Request

{
    "email" : "test"
}

• If you check the email duplicate, just send the email to the body.

Response

{
    "exist": false,     //true (This email is already occupied), false (This email is not in use => Able to use this email)
    "type": "EMAIL",    //Request for duplicate email verification
    "id": null,         //When requesting duplicate email verification, the ID has not been crossed, so null
    "email": "test"     //Duplicate confirmed e-mail
}

Check Id Duplication

Request

{
    "id" : "tester12"
}

• When confirming the duplication of the id, only the id is handed over to the body.

Response

{
    "exist": false,     //true (This Id is alredy occupied), false (This id is not in use => Able to use this id)
    "type": "ID",       //Request for duplicate ID verification
    "id": "tester12",   //Duplicate identification ID.
    "email": null       //When requesting duplicate ID verification, the email has not been crossed, so null
}

---

Login

• URL : "/api/login"

• Method : POST

Request

{   "id" : "testerid",
    "password" : "testpassword"}

Response

{   "id" : "testerid"}

---

Upload Profile Picture

• URL : "/api/uploadProfilePic"

• Method : POST

Request

{   "id" : "testerid",
    "profilePic" : file }

Response

{   "id" : "testerid"}

---

Get Profile Picture

• URL : "/api/getProfilePic"

• Method : GET

Request

{   "id" : "testerid" }

Response

file

---

Upload Background Picture

• URL : "/api/uploadBackgroundPics"

• Method : POST

Request

{   "id" : "testerid",
    "profilePic" : file }

Response

{   "id" : "testerid"}

---

Get Background Picture

• URL : "/api/getBackgroundPics"

• Method : GET

Request

{   "id" : "testerid" }

Response

file

---

Modify User Information

• URL : "/api/updateUser"

• Method : PATCH

Request

{
    "id" : "tester1",
    "password" : "password1",
    "newPassword" : "1234",
    "userName" : "TestUpdate",
    "email" : "update@email.com"
}

Response

{   "id" : "testerid"}

---

Upload Music

• URL : "/api/uploadMusic

• Method : POST

Request

{   
    "userId" : "testerId",
    "title" : "testMusic",
    "musicFilePath" : file
}

Response

{   
    "id" : "testMusicId",
    "title" : "testMusicTitle" 
}

---