[미소 클론코딩 프로젝트] 2-13. 관리자 서비스 API 설계 - 협력업체 관리

2023.08.12 - [분류 전체보기] - [미소 클론코딩 프로젝트] 2-12. 관리자 서비스 API 설계 - 계약서 관리

[미소 클론코딩 프로젝트] 2-12. 관리자 서비스 API 설계 - 계약서 관리

 

안녕하세요. 기깔나는 사람들에서 백엔드를 맡고있는 황시아입니다.

이번 시간엔 관리자 페이지에서 협력업체를 관리하는 API를 설계해 보겠습니다.

 

---

협력업체 관리 API

관리자 페이지에서 등록된 협력업체와 계약을 진행할 수 있는 서비스입니다.

 

---

계약서 조회

Request

API 호출 방식

요청 URL	메서드
/api/administrators/vendors/contracts/{id}	GET

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Syntax

curl -X GET http://{BASE_URL}/api/administrators/vendors/contracts/{id} \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	필수	계약서 정보
id	data	Integer	필수	계약서 일련번호
name	data	String	필수	협력업체명
representative	data	String	필수	대표자명
contact	data	String	필수	연락처
email	data	String	필수	이메일
corporationNumber	data	String	필수	사업자등록번호
since	data	String	필수	업력
businessRegistrationCopy	data	MultipartFile	필수	사업자등록증 사본 업로드 URL
accountCopy	data	MultipartFile	필수	통장사본 업로드 URL
signed	data	Boolean	필수	서명여부

 

Response Syntax

{
  "statusCode": 200,
  "message": "성공",
  "data": {
    "id": "계약서 일련번호",
    "name": "업체명",
    "representative": "대표자명",
    "contact": "연락처",
    "email": "이메일",
    "corporationNumber": "사업자등록번호",
    "since": "업력",
    "businessRegistrationCopy": "사업자등록증 사본",
    "accountCopy": "통장사본",
    "signed": "서명여부"
  }
}

---

계약 승인

Request

API 호출 방식

요청 URL	메서드
/api/administrators/vendors/contracts/{id}/approve	PUT

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Elements

없음

 

Request Syntax

curl -X PUT http://{BASE_URL}/api/administrators/vendors/contracts/{id}/approve \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	필수	협력업체 계정정보
id	data	Integer	필수	협력업체 일련번호
loginId	data	String	필수	관리자 서비스 로그인 아이디
password	data	String	필수	비밀번호

 

Response Syntax

{
  "statusCode": 200,
  "message": "성공",
  "data": {
    "id": 1,
    "loginId": "로그인 아이디",
    "password": "비밀번호"
  }
}