Search
Duplicate

API 명세서

Search
API Docs v3 2024-01-25 (금) ~ [ADMIN 추가]
Description
기능
method
URL
request header
request
response header
response
권한
구현
담당자
웹
Open
홈
GET
/
Open
No
회원가입
GET
/signup
Open
No
로그인
GET
/login
Open
No
프로필
GET
/profile
Open
User
상품 상세
GET
/products/{id}
Open
No
상품 구매
GET
/buy/{productId}
Open
User
상품 판매
GET
/sell/{productId}
Open
User
유저
Open
로그인
POST
/api/users/login
Open
{ “loginId” : “loginId”, “password” : “user_password” }
{ “AccessToken” : “Barer …”, “RefreshToken” : “Barer …” }
{ "message": "성공" ”data”: {} }
No
회원가입
POST
/api/users/signup
Open
{ “loginId” : “loginId”, “password” : “user_password”, “nickname” : “nickname” }
{ "message": "성공" ”data”: {} }
No
소셜 로그인
POST
/api/users/social?type=kakao
Open
{ “code” : “소셜 로그인 코드” }
{ “AccessToken” : “Barer …”, “RefreshToken” : “Barer …” }
{ "message": "성공" ”data”: {} }
No
로그아웃
POST
/api/users/logout
Open
{ “AccessToken” : “Barer …”, “RefeshToken” : “Barer …” }
User
사용자 포인트 조회
GET
/api/users/points
Open
{ “AccessToken” : “Barer …”, “RefeshToken” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "point": 0 } }
User
포인트충전
POST
/api/users/points
Open
{ “AccessToken” : “Barer …”, “RefeshToken” : “Barer …” }
{ “points” : “20000” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "nickname" : "유저 닉네임", "points" : "충전 후 포인트" } }
User
환급요청
POST
/api/users/refunds
Open
{ “AccessToken” : “Barer …”, “RefeshToken” : “Barer …” }
{ “points” : “20000” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "point": 0 } }
User
쿠폰
Open
사용자의 사용할 수 있는 쿠폰 조회
GET
/api/coupons
Open
{ “AccessToken” : “Barer …”, “RefeshToken” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "name": "string", "discountType": "string", "discount": 0 } ] }
User
사용자의 사용완료한 쿠폰 조회
GET
/api/coupons/used
Open
{ “AccessToken” : “Barer …”, “RefeshToken” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "name": "string", "discountType": "string", "discount": 0 } ]
User
상품
Open
전체 조회 (브랜드와 이름)
GET
/api/products?brand={brand}&name={name}
Open
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "id": 0, "brand": "string", "name": "string", "imageUrl": "string", "description": "string", "price": 0 } ] }
No
상세 조회
GET
/api/products/{Id}
Open
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "id": 0, "brand": "string", "name": "string", "imageUrl": "string", "description": "string", "price": 0 } }
No
사용자의 관심 상품 목록 조회
GET
/api/products/likes
Open
{ “AccessToken” : “Barer …”, “RefeshToken” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "id": 0, "brand": "string", "name": "string", "imageUrl": "string", "description": "string", "price": 0 } ] }
User
사용자가 관심 상품 등록
POST
/api/products/{id}/like
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "message": "string" } }
User
사용자가 관심 상품 등록 해제
DELETE
/api/products/{id}/dislike
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "message": "string" } }
User
시스템 체결 거래 내역 조회
GET
/api/products/{Id}/trade
Open
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "id": 0, "finalPrice": 0, "tradeDate": "2024-01-18T01:35:06.476Z" } ] }
No
시스템 판매 입찰가 조회
GET
/api/products/{Id}/sell
Open
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "sellPrice": 0, "quantity": 0 } ] }
No
시스템 구매 입찰가 조회
GET
/api/products/{Id}/buy
Open
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "buyPrice": 0, "quantity": 0 } ] }
No
판매 기프티콘 검수 신청
POST
/api/gifticons/inspect/{id}
Open
주문
Open
판매
Open
즉시판매
POST
/api/sell/{productId}/now
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ “price” : “23,000”, “gifticonUrl” : “C:\Users\Hwnag\Desktop\image” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "orderId": 0, "price": 0 } }
User
판매입찰
POST
/api/sell/{productId}
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ “price” : “23000”, “gifticonUrl” : “C:\Users\Hwnag\Desktop\image” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "price": 0, "sellId": 0 } }
User
판매 입찰 취소
DELETE
/api/sell/bid/{sellId}
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "sellId": 0 } }
User
사용자 판매 입찰 내역
GET
/api/sell/history/onprogress
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "sellId": 0, "sellPrice": 0, "bidStartedAt": "2024-01-18T01:39:16.850Z", "bidDeadlineAt": "2024-01-18T01:39:16.850Z", "productId": 0, "productBrand": "string", "productName": "string", "gifticonId": 0, "gifticonImageUrl": "string" } ] }
User
사용자 판매 완료 내역
GET
/api/sell/history/end
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "orderId": 0, "tradedDate": "2024-01-18T01:39:25.492Z", "finalPrice": 0, "productId": 0, "brand": "string", "name": "string", "iamgeUrl": "string" } ] }
User
구매
Open
구매입찰
POST
/api/buy/{productId}
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "price": 0, "period": 0, "couponId": 0 }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "price": 0, "buyId": 0 } }
User
즉시구매
POST
/api/buy/{productId}/now
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "price": 0, "couponId": 0 }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "orderId": 0, "expectedPrice": 0, "finalPrice": 0 } }
User
구매 입찰 취소
DELETE
/api/buy/bid/{buyId}
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": { "buyId": 0 } }
사용자 구매 입찰 내역
GET
/api/buy/history/onprogress
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "buyId": 0, "productId": 0, "productBrand": "string", "productName": "string", "couponId": 0, "couponName": "string", "price": 0, "discountPrice": 0, "coupon": { "createdAt": "2024-01-18T01:40:41.730Z", "modifiedAt": "2024-01-18T01:40:41.731Z", "id": 0, "name": "string", "discountType": "RATE", "discount": 0, "status": "AVAILABLE", "user": { "createdAt": "2024-01-18T01:40:41.731Z", "modifiedAt": "2024-01-18T01:40:41.731Z", "id": 0, "loginId": "string", "nickname": "string", "password": "string", "point": 0, "role": "ADMIN", "provider": "LOCAL" } } } ] }
User
사용자 구매 완료 내역
GET
/api/buy/history/end
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "orderId": 0, "orderCreatedAt": "2024-01-18T01:40:41.735Z", "expectedPrice": 0, "finalPrice": 0, "productId": 0, "productBrand": "string", "productName": "string", "gifticonId": 0, "gifticonUrl": "string" } ] }
User
백오피스
Open
상품추가
POST
/api/admin/products
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "brand":"brand", "name":"name", "imageUrl":"imageUrl", "description":"description", "price":10000 }
{ "status": "100 CONTINUE", "code": 0, }
ADMIN
환급 조회
GET
/api/admin/refunds
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ { "refundId": 환급아이디, "userId": 유저아이디, "refundPoint": 포인트, // 환급한 포인트 "refundBank": 은행, "refundAccountNumber": 계좌번호, }, { "refundId": 환급아이디, "userId": 유저아이디, "refundPoint": 포인트, // 환급한 포인트 "refundBank": 은행, "refundAccountNumber": 계좌번호, }, ,,, ] }
ADMIN
환급 승인
DELETE
/api/admin/refunds/{id}
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ }
{ "status": "100 CONTINUE", "code": 0, "message": "string", "data": [ ] }
ADMIN
쿠폰추가
POST
/api/admin/coupon
Open
{ “Access-Token” : “Barer …”, “Refesh-Token” : “Barer …” }
{ "name": 쿠폰이름, "discountType": 쿠폰할인타입, "discount": 쿠폰할인값(혹은 이율), "status": 쿠폰상태 }
{ "status": "100 CONTINUE", "code": 0, }
ADMIN
여기 잠들다.
Made with