API 명세서

아마따 API 명세서

Auth

• 로그인

  • url : /user/login
  • 메서드 : POST
  • 기능 : 로그인
  • 파라미터 : email (string), password (string)

• 로그아웃

  • url : /user/logout
  • 메서드 : POST
  • 기능 : 로그아웃
  • 파라미터 : X

• 회원가입

  • url : /user/join
  • 메서드 : POST
  • 기능 : 회원가입
  • 파라미터 : email (string), name (string), phoneNumber (string), password (string)

• 비밀번호 찾기

  • url : /user/find어쩌구
  • 메서드 : POST
  • 기능 : 비밀번호 찾기
  • 파라미터 : name (string),

• 이메일 찾기

  • url : /user/find어쩌구
  • 메서드 : POST
  • 기능 : 이메일 찾기
  • 파라미터 : name (string), phoneNumber (string)

• 비밀번호 수정

  • url : /user/change??????
  • 메서드 : POST
  • 기능 : 비밀번호 수정
  • 파라미터 : password (string)

User

• 마이페이지

  • url : /user/mypage
  • 메서드 : GET
  • 기능 : 유저 정보 받아오기
  • 파라미터 : X

Gift

• 기프티콘 리스트 페이지

  • url : /gift/list
  • 메서드 : GET
  • 기능 : 유저의 기프티콘 리스트 보여줌
  • 파라미터 : sortType (string)

• 기프티콘 사용내역

  • url : /gift/usedList
  • 메서드 : GET
  • 기능 : 기프티콘 사용내역
  • 파라미터 : X

• 기프티콘 사용 완료

  • url : /gift
  • 메서드 : PUT
  • 기능 : 기프티콘 사용 완료 처리
  • 파라미터 : id (number) / 기프티콘 ID

• 기프티콘 텍스트 추출

  • url : /gift/text
  • 메서드 : POST
  • 기능 : 외부 api 이용해 기프티콘 이미지에 있는 텍스트 정보 반환
  • 파라미터 : image base64 encoded (string), format (string)

• 기프티콘 등록

  • url : /gift
  • 메서드 : POST
  • 기능 : 기프티콘 등록
  • 파라미터 : image (blob), itemName (string), brandName (string), expireDate (Date), price (number) / option

• 기프티콘 삭제

  • url : /gift
  • 메서드 : DELETE
  • 기능 : 기프티콘 삭제
  • 파라미터 : id (number) / 기프티콘 ID

• 선물하기

  • url : /gift/?
  • 메서드 : ?
  • 기능 : 기프티콘 선물
  • 파라미터 : name (string), phoneNumber (string), id (number) / 기프티콘 ID