버전 비교

Version 이전 버전 7 새 버전 8
변경한 사람

X2BEE 관리자

정우문

에 저장

키

  • 이 줄이 추가되었습니다.
  • 이 줄이 삭제되었습니다.
  • 서식이 변경되었습니다.

...

  • Path Variable : /v1/standardCategory/{depthNo}
    다음은 'depthNo' 파라미터를 '1'로 지정하여 호출하는 예제입니다.

    코드 블럭
    languagesql
    curl -X GET \
'https://beta-venus-api-display.x2bee.com/api/display/v1/standardCategory/1' 
-H 'accept: application/json'

  • Query String : GET /v1/site/popupList
    다음은 'despMediaCd, popupTgtScrnCd, dispMediaDtlCd, chlDtlNo, prtTypCd’ 파라미터를 Query String (& 구분자로 파라미터 분리) 으로 호출한 예제입니다.

    코드 블럭
    languagesql
    curl -X 'GET' \
'https://beta-venus-api-display.x2bee.com/api/display/v1/site/popupList?dispMediaCd=10&popupTgtScrnCd=01&dispMediaDtlCd=aos&chlDtlNo=1000001&prtTypCd=01' 
-H 'accept: */*'

...

  • Request Body: POST /v1/payment/refundMileagePayment
    다음은 POST 방식으로 Request Body에 파라미터를 담아 호출한 예제입니다.

    코드 블럭
    curl -X 'POST' \
'httphttps://beta-venus-api-order.x2bee.com/api/order/v1/payment/refundMileagePayment' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '[
  {
    "searchStartDt": "2023-09-12",
    "searchEndDt": "2023-09-12",
    "ordNo": "string",
    "payGbCd": "string",
    "payStatCd": "string",
    "ordMediaCd": "string",
    "payNo": "string",
    "uprPayNo": "string",
    "ordDtlGbCd": "string",
    "claimNo": "string",
    "rfdAmt": 0,
    "payAmt": 0,
    "mbrNo": "string",
    "payWayCd": "string"
  }
]'

...

  • Request Body: PUT /v1/order/stockUpdate
    다음은 PUT 방식으로 Request Body에 파라미터를 담아 호출한 예제입니다.

    코드 블럭
    curl -X 'PUT' \
'https://beta-venus-api-goods.x2bee.com/api/goods/v1/order/stockUpdate?goodsNo=1&itmNo=2&stockCnt=3&stockIncreaseCd=-' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '[
  {
    "goodsNo": "string",
    "itmNo": "string",
    "stockCnt": 0,
    "stockIncreaseCd": "string",
    "stkQty": 0,
    "itmSaleStatCd": "string"
  }
]'

...

  • Query String: DELETE /v1/customerservice/questionDel
    다음은 DELETE 방식으로 Query String에 파라미터를 담아 호출 예제입니다.

    코드 블럭
    curl -X 'DELETE' \
'httphttps://beta-venus-api-order.x2bee.com/api/order/v1/customerservice/questionDel?accpStrtDt=string&accpEndDt=string&mbrNo=string&cnslNo=string' \
-H 'accept: */*'

...

API 상태 코드 (API Status Code)

Code

설 명

200 OK

API 요청 성공 시 발생

201 Created

요청 성공 및 새로운 자원이 만들어진 상태 (Created)

204 No Content

서버가 클라이언트 요구를 처리했으나 전송할 데이터가 없는 상태 (Delete)

304 Not Modified

요청된 리소스를 재전송할 필요가 없는 경우 발생 (Caching)

500 Internal Server Error

서버 에러 시 발생

900 Bad Request

API 요청 실패 시 발생

901 Unauthorized

접근 권한이 없는 경우 발생 (로그인이 되어 있지 않은 경우 발생)

903 Forbidden

권한 밖의 일을 수행할 경우 발생 (로그인이 되어 있지만 접근 권한이 없는 경우 발생)

904 Not Found

해당 URI 와 매칭되는 리소스가 없는 경우 발생

905 Method Not Allowed

지원하지 않는 메서드로 요청 시 발생

Rw ui textbox macro
typeinfo

400번대 Http Status Code값의 경우 X2BEE Framework에서는 900번대 HTTP Status Code값으로 변경하여서 사용합니다.
(ex. 400 → 900, 401 → 901)