하위 호환성

해외 결제 API 서비스는 하위 호환성 준수 변경에 대해서는 제공되는 API의 버전 변경 없이 진행됩니다. 하위 호환성 미준수 변경에 대해서는 새롭게 릴리즈 하거나, 신규 URI를 통해 제공 됩니다.

하위 호환성 준수 변경기준

• 신규 API 엔드포인트 추가
• API 요청에 새로운 선택 파라미터 추가
• API 요청에서 필수 파라미터를 선택 파라미터로 변경
• API 응답에 새로운 파라미터 추가
• 새로운 Enum Value 추가
• 새로운 오류 코드 추가 및 오류 메시지 변경

하위 호환성 비준수 변경기준

• API 엔드포인트 제거
• API 요청에 새로운 필수 파라미터 추가
• API 요청에서 선택 파라미터를 필수 파라미터로 변경
• API 응답에 사용 필수 파라미터 삭제
• API 요청 및 응답 항목의 데이터 타입 변경

클라이언트 하위 호환성 설정 가이드

Java의 예를 들어 설명하면, Jackson의 경우 ObjectMapper를 선언해서 사용하면 default 옵션이 기본적으로 켜져 있기 때문에 필드가 추가되었을 때 이를 처리하지 못합니다.

이지페이 API의 필드 추가 등의 변경으로 인하여 영향을 발생하지 않도록 아래와 같은 설정이 필요 합니다.

Java Object Mapper 설정

// jackson 1.9 and before
objectMapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// or jackson 2.0
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);