Mileage API

CREMA 어드민에서 적립금을 지급할 때, 쇼핑몰 서버와 연동하는 방법을 제공합니다.

Mileage API 사용하기

Mileage API를 사용하려면 쇼핑몰 측에 아래와 같이 Callback URL을 받아서 적립금 지급을 하고 결과를 리턴해주는 API를 구현하셔야 합니다. 그리고 Callback URL을 소통하시는 API개발 담당자분에게 메일로 전달해주시면, 내부에서 등록을 해드립니다. 이후 담당자와 소통하여 검수를 진행하면 됩니다.

Callback URL Parameters

이름	타입	필수	설명
`user_code`	string	✔	적립금을 지급 받을 회원의 쇼핑몰 아이디입니다.
`amount`	integer	✔	적립금 액수. 적립금 회수의 경우 음수로 요청이 되므로, 음수인 경우도 고려되어야 합니다.
`review_id`	integer	✖	적립금 지급할 리뷰 `id`
`product_code`	string	✖	상품 `code`
`order_code`	string	✖	주문 `code`
`sub_order_code`	string	✖	주문상품 `code`
`message`	string	✔	적립금 지급 사유
`created_at`	datetime(ISO 8601)	✖	리뷰 생성 날짜 `2021-02-10T00:02:10.000+09:00`

요청(Request)

POST CallbackURL HTTP/1.1
Content-Type: application/x-www-form-urlencoded;

user_code=test_user&amount=500&message=test_message

응답(Response)

이름	타입	필수	설명
`code`	integer	✔	적립금 지급이 성공했을 경우 `0`을, 실패 했을 경우는 에러 코드를 리턴합니다.
`message`	string	✔	적립금 지급이 실패했을 경우에 실패 이유를 리턴합니다.

적립금 지급 성공 응답 예시
(응답이 JSON 형식에 맞지 않으면 적립금 지급 시 에러가 발생합니다.)

HTTP/1.1 200 OK

{
  "code": 0,
  "message": "success"
}

적립금 지급 실패 응답 예시

{
  "code": 1,
  "message": "not permitted IP"
}