02. 유즈케이스

회원관리 API 유즈케이스

• 사용자는 회원(구매자, 판매자, 관리자 등)과 비회원으로 구분된다.

• 회원은 주문 서비스를 이용하기 위해 회원가입을 해야 한다.

• 회원은 다른 회원과 구분될 수 있는 유일한 아이디/이메일 값을 갖는다.(중복검사)

• 회원은 개인 휴대전화 번호를 통해 본인 인증을 해야 한다.

• 회원은 정보수신 동의를 통해 주문완료 이메일을 받을 수 있다.(선택)

• 회원은 마이페이지를 통해,

  • 주문목록/배송조회를 확인할 수 있다.
  • 취소/반품/교환/환불 내역을 확인할 수 있다.
  • 정기배송관리를 사용할 수 있다(보류)
  • 쿠폰을 조회할 수 있다.
  • 문의하기 가능(보류)
  • 개인 정보 확인 및 수정 가능
  • 배송주소 관리 가능

• 사용자(비회원 & 회원)는 카테고리 혹은 검색창을 통해 상품을 검색할 수 있다.

• 회원은 상품을 장바구니에 담거나 바로 주문할 수 있다.

• 회원은 회원가입시 입력한 정보를 통해 아이디 및 비밀번호를 찾을 수 있다.

회원관리 API Signature

by wilco82

Method Name	URI	Parameters	Description
signUp	POST /members	memberDTO : 회원 DTO 객체	회원가입
getMemberInfo	GET /members	session : 회원의 세션	회원의 마이페이지 조회
logIn	POST /members/{memberId}	session : 회원의 세션 id : 회원의 아이디 password : 회원의 비밀번호	회원 로그인
logOut	GET /members/{memberId}	session : 회원의 세션	회원 로그아웃
updatePassword	PATCH /members/password	session : 회원의 세션 currentPassword : 현재 비밀번호 newPassword : 새 비밀번호	회원 비밀번호 변경
updateAddress	PATCH /members/address	session : 회원의 세션 newAddress: 새 배송주소	회원 배송주소 변경
deleteMember	DELETE /members	session : 회원의 세션 id : 회원의 아이디 password : 회원의 비밀번호	회원 삭제

주문&결제관리 API 유즈케이스

• 주문과 결제는 무조건 회원만 이용가능하다.
• 결제수단은 외부 PG사에 일임한다.(결제모듈 사용)
• 회원은 상품과 옵션을 선택하고, 배송주소와 결제수단을 정하여 주문을 접수할 수 있다.
• 주문신청은 상품을 바로 구매하거나 장바구니를 통해 할 수 있다.
• 회원가입시 이메일 수신을 동의한 회원에 한하여 해당 이메일로 주문완료 메일을 받는다.
• 주문접수 이후에 배송단계에 들어가지 않았다면 바로 취소가 가능하다.
• 접수한 주문이 배송단계에 들어간 이후에 취소는 불가능하며 환불 및 교환신청을 해야 한다.
• 상품의 종류에 따라 취소신청 자체가 불가능한 경우가 있다.

주문&결제관리 API Signature

by wilco82

Method Name	URI	Parameters	Description
registerOrder	POST /orders	session : 회원의 세션 orderInfo : 주문 데이터	주문생성
getOrderInfo	GET /orders/{orderId}	session : 회원의 세션 orderId : 주문 번호	주문조회

상품관리&카테고리 API 유즈케이스

• 상품은 크게 대중소 카테고리로 분류한다. 단, 상품검색은 중 카테고리 부터 검색이 가능하다.
• 상품 정보는 공통된 정보+특수 정보로 이루어져 있다.
• 모든 회원은 상품을 옵션을 통해 원하는 방식대로 상품을 고를 수 있다.
• 관리자는 정해진 방식에 따라 상품등록, 수정, 삭제가 가능하다.
• 관리자는 카테고리 관리도 가능하다.
• 하나의 카테고리가 지워지면, 기존의 카테고리에 속해있던 상품의 카테고리는 '미지정'에 분류된다.

상품관리 API signiture

by wanniDev

api signiture	uri	paramater	description
addItem	POST /items	x	권한이 있는 사용자가 아이템을 등록한다.
searchItems	GET /items	category-name : 검색할 카테고리 이름 date : 등록순 혹은 역순 * 파라미터 값이 없는 경우, 기본 첫 페이지 아이템 콜렉션을 리턴	불특정 사용자가 등록된 아이템을 조건에 따라 검색
getItem	GET /items/{itemId}	x	특정 아이템 조회
updateItem	PUT /items/{itemId}	x	단건 아이템 수정
updateItemsCategories	PUT /items	x	주어진 아이템 콜렉션의 카테고리 변경
deleteItem	DELETE /items	x	단건 혹은 대량 아이템 삭제

카테고리 API signiture

by wanniDev

api signiture	uri	paramater	description
addCategory	POST /categories	x	카테고리 등록
searchCategories	GET /categories	dep1 : 대 카테고리 dep2 : 중 카테고리 dep3 : 소 카테고리 * 파라미터값이 없으면 기본 전체 조회	조건 별 카테고리 조회
getCategory	GET /categories/{categoryId}	x	단건 카테고리 조회
editCategory	PUT /categories	x	단건 카테고리 수정
deleteCategory	DELETE /categories	x	단건 카테고리 삭제

배송관리 API 유즈케이스

• 회원은 배송지를 미리 저장할 수도 있고, 주문 페이지에서 바로 저장할 수도 있다.
• 회원은 특정 배송단계 이전까지는 배송지 변경 신청을 할 수 있다.
• 주문이 접수되고, 일정기간이 지나면, 배송단계가 변경된다.
• 관리자는 배송단계별로 혹은 운송장 번호로 배송목록을 조회할 수 있다.

배송관리 API signiture

by wanniDev

api signiture	uri	paramater	description
searchDelivery	GET /deliveries	delivery-id : 운송장 번호 delivery-stat : 배송상태 delivery-policy : 배송정책	배송 조회
deleveryManage	PUT /deliveries	x	배송 관리
addDeliveryPolicy	POST/deliveries/policies	x	배송정책 추가
editDeliveryPolicy	PUT/deliveries/policies	x	배송정책 수정
searchDeliveryPolicy	GET /deliveries/policies	x	배송정책 검색