API 구조 정의 | Notion

로그인 / 회원가입

회원가입(RegisterUser) - signUp
1. 프론트→백엔드
  1. 42API Code(code)
  2. 클러스터네임(userClusterName)
  3. 비밀번호(userPassword)
  4. 데드라인(userDeadline)
  5. 이메일(userEmail)
2. 백엔드→프론트
  - 성공시
    
    없음
  - 실패시
    
    오류 출력
비밀번호 초기화(ResetPassword, 42API 사용하면 안됨) - resetPassword
1. 클러스터네임(userClusterName)
2. 이메일(userEmail)
백엔드→프론트
- 성공시
  
  없음
- 실패시
  
  오류 출력
로그인 - signUp
1. 아이디 (userClusterName)
2. 비밀번호(userPassword)
백엔드→프론트
- 성공시
  1. 액세스 토큰(accessToken, 30분 만료)
  2. 유저해시값(userID)
- 실패시
  
  오류 출력

바탕화면 (메세지 수신자)

메세지 전송자 닉네임 가져오기( 디렉토리 진입시 파일 형태로 전송자 보여주기) - getMessageNickname
1. 수신자 토큰(accessToken) ⇒ authorization에 넣을것
2. 수신자 유저해시값(userID)
백엔드→프론트
- 성공시
  
  전송자 닉네임 배열([userNickname,...])
- 실패시
  
  오류 출력
메세지 정보 가져오기( 파일 중에 하나라도 누르면 전체 데이터를 수신) - getMessage

→ 백엔드에서 데드라인 판단해서 보내주던지 에러를 보냄
1. 수신자 토큰(accessToken) ⇒ authorization에 넣을것
2. 수신자 유저해시값(userID)
백엔드→프론트
- 성공시
  
  메세지 전체 데이터 배열 메세지 타이틀, 메세지, 닉네임(클러스터 네임 제외)
- 실패시
  
  오류 출력

바탕화면 (메세지 작성자)

받는사람에 대한 유저 아이디 받아오기. 메세지 링크를 타고 온 순간 서버에 요청. - getUserId
1. 유저해시값(userID)
백엔드→프론트
- 성공시
  
  받는사람 클러스터네임
- 실패시
  
  오류 출력
메세지 전송(SendMessage) - sendMessage
1. 42API access_token(accessToken) ⇒ authorization에 넣을것
2. 유저해시값(userID)
3. 메세지 작성자(senderClusterName)
4. 메세지 작성자 닉네임(senderNickname)
5. 메세지 제목(messageTitle)
6. 메세지 내용(messageText)
백엔드→프론트
- 성공시
  
  작성자의 메세지 전송횟수(sendMessageCount)
- 실패시
  
  오류 출력

공통 오류 객체

서버오류 (backend 오류 500대) - “서버 오류입니다 잠시 후 다시 시도해주세요”
잘못된 요청 (토큰관련?)
- 상태코드 : 401 권한없음
- 백엔드 에러메세지 : Unauthorized
- 프론트 안내문구 : “잘못된 요청을 보냈습니다. 요청을 다시 확인해 주세요”
지정된 날짜가 아닌경우
- 상태코드 : 400
- 백엔드 에러메세지 : NotExpiredDate
- 프론트 안내문구 : “지정된 날짜가 되지 않아 메세지를 확인 할 수 없습니다”
유저 정보가 중복(회원가입)
- 상태코드 : 400
- 백엔드 에러메세지 : DuplicatedUser
- 프론트 안내문구 : “중복된 회원이 존재합니다”
4개 이상의 메세지를 보낼때
- 상태코드 : 400
- 백엔드 에러메세지 : ExceededMessageCount
- 프론트 안내문구 : “메세지는 최대 3개까지만 보낼 수 있습니다”
만료된 사용자 정보를 요청한 경우(메세지 전송 페이지에서 사용)
- 상태코드 : 400
- 백엔드 에러메세지 : ExpiredLinkDate
- 프론트 안내문구 : “만료된 링크입니다.”
로그인 정보/이메일 정보(비밀번호 재설정)가 맞지 않을때