우주먼지
Published 2023. 1. 26. 22:03
📄 API 명세서 - 상담프로그램 & 결제 & 예약 Project/Main Project

1. 💡 API 명세서 - 상담프로그램 & 결제 & 예약

 

상담프로그램 & 결제 & 예약 API 명세서

 

1.1. (관리자) 프로그램 등록

POST 프로그램 등록
/api/programs/post
프로그램 등록 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request POST 'http://43.200.39.48/api/programs/post' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTU2MDQsImV4cCI6MTY3NDY1NjUwNCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.K5GgQCRusqK9P4EXbERgefymfq4OXU3gN-de1owhk2is1ij0ID6csvF6f9K0jagF3vxNlQ9p0dOBkXpUnbm_vQ' \
--data-raw '{
    "title" : "프로그램 제목2",
    "content" : "프로그램 내용2",
    "image" : "프로그램 대표 이미지2",
    "userMax" : 15,
    "dateStart" : "프로그램 시작시간",
    "dateEnd" : "프로그램 종료시간",
    "symptomTypes" : [
        "증상1",
        "증상4"
    ],
    "cost" : 60000,
    "counselorId" : 2
}
Example Response 201 Created
No Response Body

 

1.2. (관리자) 프로그램 수정

PATCH 프로그램 수정
/api/programs/patch/1
관리자의 프로그램 수정 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request PATCH 'http://43.200.39.48/api/programs/patch/1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTQ2NDcsImV4cCI6MTY3NDY1NTU0NywibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.tXcxnvPzSv90RE5K1M6i3QhjxmKWRAUN3TsBxX_yDmB-5-XHYZTfybMVNu4De-xgze34QkdIqc2JD0mtAnGCUQ' \
--data-raw '{
    "title" : "프로그램 제목 수정1",
    "content" : "프로그램 내용 수정1",
    "image" : "프로그램 대표 이미지 수정1",
    "userMax" : 20,
    "dateStart" : "프로그램 시작시간 수정1",
    "dateEnd" : "프로그램 종료시간 수정1",
    "symptomTypes" : [
        "증상2 수정1",
        "증상3 수정1"
    ],
    "cost" : 30000,
    "counselorId" : 2
}'
Example Response 200 OK
{
  "data": {
    "programId": 1,
    "title": "프로그램 제목 수정1",
    "content": "프로그램 내용 수정1",
    "image": "프로그램 대표 이미지 수정1",
    "userMax": 20,
    "dateStart": "프로그램 시작시간 수정1",
    "dateEnd": "프로그램 종료시간 수정1",
    "cost": 30000,
    "symptomTypes": [
      "증상2 수정1",
      "증상3 수정1"
    ],
    "counselorId": 2
  }
}

 

1.3. (상담사) 마이페이지 나의 프로그램 수정

PATCH 마이페이지 나의 프로그램 수정
/api/programs/patch/counselor/{counselor-id}
상담사의 마이페이지 프로그램 수정 시사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request PATCH 'http://43.200.39.48/api/programs/patch/counselor/1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTUzNjEsImV4cCI6MTY3NDY1NjI2MSwibWVtYmVySWQiOjIsInJvbGUiOiJDT1VOU0VMT1IifQ.bSEdk0ksU_etnaWKDRELTT41bqFyAKyOQcVALJheNntkIViz73pl5XxTsG52e32rJ15njG9FnHG2ApTonNow3w' \
--data-raw '{
    "zoomLink" : "링크 정보",
    "announce" : "전달 사항 정보"
}'
Example Response 200 OK
{
  "data": {
    "zoomLink": "링크 정보",
    "announce": "전달 사항 정보"
  }
}

 

1.4. (공통) 프로그램 조회

GET 프로그램 조회
/api/programs/lookup/{program-id}
프로그램 조회 시 사용하는 엔드포인트 입니다

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/programs/lookup/1'
Example Response 200 OK
{
  "data": {
    "programId": 1,
    "title": "프로그램 제목 수정1",
    "content": "프로그램 내용 수정1",
    "userMax": 20,
    "userCount": 0,
    "cost": 30000,
    "image": "프로그램 대표 이미지 수정1",
    "dateStart": "프로그램 시작시간 수정1",
    "dateEnd": "프로그램 종료시간 수정1",
    "symptomTypes": [
      "증상2 수정1",
      "증상3 수정1"
    ],
    "counselorName": "오은영",
    "profile": "https://cdn.crowdic.net/list-thumb/thumb_l_FD8184F80AF8D28615C95B97C1AE4D63.jpeg",
    "introduce": "소개",
    "expertiseField": "전문분야"
  }
}

 

1.5. (공통) 프로그램 전체 조회

GET 프로그램 전체 조회
/api/programs/lookup/list
프로그램 전체 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/programs/lookup/list'
Example Response 200 OK
{
  "data": [
    {
      "programId": 2,
      "title": "프로그램 제목2",
      "dateStart": "프로그램 시작시간",
      "dateEnd": "프로그램 종료시간",
      "symptomTypes": [
        "증상1",
        "증상4"
      ],
      "counselorName": "오은영"
    },
    {
      "programId": 1,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "symptomTypes": [
        "증상2 수정1",
        "증상3 수정1"
      ],
      "counselorName": "오은영"
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 2,
    "totalPages": 1
  }
}

 

1.6. (공통) 고민별 프로그램 조회, 추천 프로그램 조회

GET 고민별 프로그램 조회, 추천 프로그램 조회
/api/programs/lookup/search?search=증상1&page=1&size=10
고민별 & 추천별로 프로그램을 조회할 시 사용하는 엔드포인트 입니다
Params
search 증상1
page 1
size 10

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/programs/lookup/search?search=증상1&page=1&size=10'
Example Response 200 OK
{
  "data": [
    {
      "programId": 2,
      "title": "프로그램 제목2",
      "dateStart": "프로그램 시작시간",
      "dateEnd": "프로그램 종료시간",
      "symptomTypes": [
        "증상1",
        "증상4"
      ],
      "counselorName": "오은영"
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 1,
    "totalPages": 1
  }
}

 

1.7. (상담사) 마이페이지 나의 프로그램 개별 조회

GET 마이페이지 나의 프로그램 개별 조회
/api/programs/counselor/lookup/{program-id}
상담사가 나의 프로그램을 개별 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/programs/counselors/2/lookup/1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTQwNjEsImV4cCI6MTY3NDY5NDk2MSwibWVtYmVySWQiOjIsInJvbGUiOiJDT1VOU0VMT1IifQ.paumIInPt2Up9P3JCVI7_Xe5PXOPNbTAYwS8ukLtG_mhNaIPeD_QKZGOM37-uiwQRMm_U59AQd9Li9Ghdp40qw'
Example Response 200 OK
{
  "data": {
    "programId": 1,
    "title": "프로그램 제목 수정1",
    "dateStart": "프로그램 시작시간 수정1",
    "dateEnd": "프로그램 종료시간 수정1",
    "userMax": 20,
    "userCount": 1,
    "zoomLink": "링크 정보",
    "announce": "전달 사항 정보",
    "memberInPayList": [
      {
        "nickName": "googoo수정",
        "birth": "생년월일 수정"
      }
    ]
  }
}

 

1.8. (상담사) 마이페이지 나의 프로그램 전체 조회

GET 마이페이지 나의 프로그램 전체 조회
/api/programs/counselors/{counselor-id}/lookup/list
상담사가 나의 프로그램을 전체 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/programs/counselors/2/lookup/list' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTQwNjEsImV4cCI6MTY3NDY5NDk2MSwibWVtYmVySWQiOjIsInJvbGUiOiJDT1VOU0VMT1IifQ.paumIInPt2Up9P3JCVI7_Xe5PXOPNbTAYwS8ukLtG_mhNaIPeD_QKZGOM37-uiwQRMm_U59AQd9Li9Ghdp40qw'
Example Response 200 OK
{
  "data": [
    {
      "programId": 1,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "userCount": 1
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 1,
    "totalPages": 1
  }
}

 

1.9. (관리자) 마이페이지 개설 프로그램 전체 조회

GET 마이페이지 개설 프로그램 전체 조회
/api/programs/admin/lookup/list
관리자가 개설한 프로그램을 마이페이지에서 전체 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/programs/admin/lookup/list' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTMzMDYsImV4cCI6MTY3NDY5NDIwNiwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.t4a705oxswdTJlE6xzpqW5n9wLUuBrM7eusIuba5pok5KZSsXlwUi2xcf6niRWkalHYprXCfOhSvsLg0JtXq8w'
Example Response 200 OK
{
  "data": [
    {
      "programId": 2,
      "title": "프로그램 제목2",
      "dateStart": "프로그램 시작시간",
      "dateEnd": "프로그램 종료시간",
      "userMax": 15,
      "userCount": 0
    },
    {
      "programId": 1,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "userCount": 0
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 2,
    "totalPages": 1
  }
}

 

1.10. (관리자) 마이페이지 상담사 상담 이력 전체 조회

GET 마이페이지 상담사 상담 이력 전체 조회
/api/programs/admin/lookup/{counselor-id}/list
마이페이지 상담사 상담 내역 전체 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/programs/admin/lookup/2/list?page=1&size=10' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTMzMDYsImV4cCI6MTY3NDY5NDIwNiwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.t4a705oxswdTJlE6xzpqW5n9wLUuBrM7eusIuba5pok5KZSsXlwUi2xcf6niRWkalHYprXCfOhSvsLg0JtXq8w'
Example Response 200 OK
{
  "data": [
    {
      "programId": 2,
      "title": "프로그램 제목2",
      "dateStart": "프로그램 시작시간",
      "dateEnd": "프로그램 종료시간",
      "userMax": 15,
      "userCount": 0,
      "counselorId": 2,
      "counselorName": "오은영"
    },
    {
      "programId": 1,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "userCount": 0,
      "counselorId": 2,
      "counselorName": "오은영"
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 2,
    "totalPages": 1
  }
}

 

1.11. (관리자) 프로그램 삭제

DELETE 프로그램 삭제
/api/programs/delete/{program-id}
관리자가 프로그램 삭제 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request DELETE 'http://43.200.39.48/api/programs/delete/2' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTMzMDYsImV4cCI6MTY3NDY5NDIwNiwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.t4a705oxswdTJlE6xzpqW5n9wLUuBrM7eusIuba5pok5KZSsXlwUi2xcf6niRWkalHYprXCfOhSvsLg0JtXq8w'
Example Response 204 No Content
No Response Body

 

1.12. 결제 등록

POST 결제 등록
/api/pays/{program-id}/post
결제등록 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request POST 'http://43.200.39.48/api/pays/1/post' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTU5MzEsImV4cCI6MTY3NDY5NjgzMSwibWVtYmVySWQiOjgsInJvbGUiOiJVU0VSIn0.oea0dY8BQC7aJEv1MXByOnZyT3YYkhIP2XeQwynErhq37PwQ0ktGffsURiOoQPD5q3fmfCI1a4zmi8p8fMM0oA' \
--data-raw '{
    "cardOwner" : 신건우",
    "cardNum" : "1111222233334444",
    "cvvNum" : "123",
    "expirationTime" : "06/27"
}'
Example Response 201 Created
{
  "data": {
    "programId": 1,
    "programTitle": "프로그램 제목 수정1",
    "dateStart": "프로그램 시작시간 수정1",
    "dateEnd": "프로그램 종료시간 수정1",
    "cost": 30000,
    "counselorName": "오은영",
    "status": "결제 완료"
  }
}

 

1.13. (유저) 마이페이지 결제 취소 요청

PATCH 마이페이지 결제 취소 요청
/api/pays/lookup/{program-id}/edit
마이페이지에서 결제 취소 요청 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request PATCH 'http://43.200.39.48/api/pays/lookup/3/edit' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTU0NDYsImV4cCI6MTY3NDY5NjM0NiwibWVtYmVySWQiOjgsInJvbGUiOiJVU0VSIn0.6sm0v5BqejJzAIhRRG5fK3gABvh3N4LxMnts6mOlHglQT3Y_XdfroBo_OBmj8MIy7bSzrSqI4CAww95_D-WtBA'
Example Response 200 OK
{
  "data": {
    "status": "취소 대기중"
  }
}

 

1.14. (관리자) 결제 취소 요청 승인

PATCH 결제 취소 요청 승인
/api/pays/admin/{program-id}/edit
결제 취소 승인 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request PATCH 'http://43.200.39.48/api/pays/admin/3/edit' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTU1MzYsImV4cCI6MTY3NDY5NjQzNiwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.KzVvRm0sJzMnYI9hmgcWV_3sHCvFsXRhRdzsz102CqRld1GLH_VWvsdDaIuSaHCStAAZ4gkIVptPoXvM4XqqLQ'
Example Response 200 OK
{
  "data": {
    "status": "결제 취소"
  }
}

 

1.15. (유저) 마이페이지 나의 프로그램 예약내역 개별 조회

GET 마이페이지 나의 프로그램 예약내역 개별조회
/api/pays/lookup/{program-id}
유저가 마이페이지에서 결제내역 확인 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/pays/lookup/1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTU0NDYsImV4cCI6MTY3NDY5NjM0NiwibWVtYmVySWQiOjgsInJvbGUiOiJVU0VSIn0.6sm0v5BqejJzAIhRRG5fK3gABvh3N4LxMnts6mOlHglQT3Y_XdfroBo_OBmj8MIy7bSzrSqI4CAww95_D-WtBA'
Example Response 200 OK
{
  "data": {
    "payId": 1,
    "createdAt": "2023-01-26T09:42:11",
    "status": "결제 취소",
    "programId": 1,
    "title": "프로그램 제목 수정1",
    "dateStart": "프로그램 시작시간 수정1",
    "dateEnd": "프로그램 종료시간 수정1",
    "userMax": 20,
    "cost": 30000,
    "zoomLink": "링크 정보",
    "announce": "전달 사항 정보",
    "counselorName": "오은영"
  }
}

 

1.16. (유저) 마이페이지 나의 프로그램 예약내역 전체 조회

GET 마이페이지 나의 프로그램 예약내역 전체 조회
/api/pays/{member-id}/lookup/list?page=1&size=10
유저가 마이페이지 프로그램 전체 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg
Params
page 1
size 10

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/pays/8/lookup/list?page=1&size=10' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTU5MzEsImV4cCI6MTY3NDY5NjgzMSwibWVtYmVySWQiOjgsInJvbGUiOiJVU0VSIn0.oea0dY8BQC7aJEv1MXByOnZyT3YYkhIP2XeQwynErhq37PwQ0ktGffsURiOoQPD5q3fmfCI1a4zmi8p8fMM0oA'
Example Response 200 OK
{
  "data": [
    {
      "payId": 3,
      "memberId": 8,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "createdAt": "2023-01-26T10:19:07",
      "counselorName": "오은영",
      "status": "결제 취소"
    },
    {
      "payId": 2,
      "memberId": 8,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "createdAt": "2023-01-26T10:19:00",
      "counselorName": "오은영",
      "status": "결제 취소"
    },
    {
      "payId": 1,
      "memberId": 8,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "createdAt": "2023-01-26T09:42:11",
      "counselorName": "오은영",
      "status": "결제 취소"
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 3,
    "totalPages": 1
  }
}

 

1.17. (관리자) 마이페이지 특정 회원의 상담내역 전체 조회

GET 마이페이지 특정 회원의 상담내역 전체 조회
/api/pays/admin/{member-id}/lookup/list
관리자가 특정 회원의 상담 내역을 전체 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/pays/admin/8/lookup/list' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTU1MzYsImV4cCI6MTY3NDY5NjQzNiwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.KzVvRm0sJzMnYI9hmgcWV_3sHCvFsXRhRdzsz102CqRld1GLH_VWvsdDaIuSaHCStAAZ4gkIVptPoXvM4XqqLQ'
Example Response 200 OK
{
  "data": [
    {
      "payId": 3,
      "memberId": 8,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "counselorName": "오은영"
    },
    {
      "payId": 2,
      "memberId": 8,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "counselorName": "오은영"
    },
    {
      "payId": 1,
      "memberId": 8,
      "title": "프로그램 제목 수정1",
      "dateStart": "프로그램 시작시간 수정1",
      "dateEnd": "프로그램 종료시간 수정1",
      "userMax": 20,
      "counselorName": "오은영"
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 3,
    "totalPages": 1
  }
}

 

1.18. (관리자) 결제 상태별 내역 조회

GET 결제 상태발 내역 조회
/api/pays/admin/payment/list?page=1&size=10&status=CANCEL_PAYMENT
결제 상태별 내역 조회 시 사용하는 엔드포인트 입니다
Header
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2NTIzMTgsImV4cCI6MTY3NDY1MzIxOCwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.icBFQbDz1dZQ7zFf2tvYvfWaRQwEaI1ZcB24wePwF31sBNxD31uWIi_1vP3RuT3Mxso1X4R9KGPfXndDIoHPSg
Params
status CANCEL_PAYMENT
page 1
size 10

 

ExampleRequest
curl --location --request GET 'http://43.200.39.48/api/pays/admin/payment/list?page=1&size=10&status=COMPLETE_PAYMENT' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBQ0NFU1MiLCJpYXQiOjE2NzQ2OTU1MzYsImV4cCI6MTY3NDY5NjQzNiwibWVtYmVySWQiOjMsInJvbGUiOiJBRE1JTiJ9.KzVvRm0sJzMnYI9hmgcWV_3sHCvFsXRhRdzsz102CqRld1GLH_VWvsdDaIuSaHCStAAZ4gkIVptPoXvM4XqqLQ'
Example Response 200 OK
{
  "data": [
    {
      "memberId": 8,
      "memberName": "홍길동",
      "payId": 3,
      "status": "결제 완료",
      "title": "프로그램 제목 수정1",
      "cost": 30000
    },
    {
      "memberId": 8,
      "memberName": "정동규",
      "payId": 2,
      "status": "결제 완료",
      "title": "프로그램 제목 수정1",
      "cost": 30000
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 10,
    "totalElements": 2,
    "totalPages": 1
  }
}
저작자표시

'Project > Main Project' 카테고리의 다른 글

💻 기능 개발 - 게시물  (0) 2023.01.26
💻 기능 개발 - 회원  (0) 2023.01.26
📄 API 명세서 - 상담사 & 게시물 & 공지사항  (0) 2023.01.26
📄 API 명세서 - 사용자 & 로그인 & 로그아웃  (0) 2023.01.26
📄 ERD 설계 & 테이블 명세서  (0) 2023.01.10
profile

우주먼지

@o귤o

포스팅이 좋았다면 "좋아요❤️" 또는 "구독👍🏻" 해주세요!

검색 태그

티스토리툴바