API 공통 사항

요청/응답 형식

Base URL

https://api.aiconbiz.kr

모든 API 요청은 HTTPS만 허용됩니다.

Content-Type

POST 요청 시 Content-Type: application/json을 사용합니다. GET 요청에는 별도의 Content-Type이 필요하지 않습니다.

에러 응답 형식

모든 에러 응답은 다음 공통 형식을 따릅니다.

{
  "status": 400,
  "code": "COUPON_INVALID_COUPON_ID",
  "message": "쿠폰 ID 형식이 올바르지 않습니다.",
  "detail": {
    "couponId": "invalid_id"
  },
  "requestId": "req_01H..."
}

필드	타입	설명
`status`	number	HTTP 상태코드와 동일
`code`	string	머신 리더블 에러 코드 (고정 계약)
`message`	string	사람이 읽을 수 있는 에러 메시지
`detail`	object \| null	에러별 추가 정보
`requestId`	string	서버 추적 ID (문의 시 전달)

에러 메시지 언어

Accept-Language 헤더로 에러 메시지 언어를 선택할 수 있습니다.

헤더 값	메시지 언어
`en`, `en-US` 등	영어
없음 또는 기타	한국어 (기본)

자세한 에러 코드는 에러 레퍼런스를 참고하세요.

API 버저닝

API 버전은 URL 경로의 v1으로 관리됩니다.

https://api.aiconbiz.kr/v1/coupons

하위 호환되는 변경(새 응답 필드 추가, 새 선택적 파라미터 등)은 별도 버전 없이 반영됩니다. 클라이언트는 알 수 없는 응답 필드를 무시하도록 구현하세요.

요청/응답 형식​

Base URL​

Content-Type​

에러 응답 형식​

에러 메시지 언어​

API 버저닝​