버전 관리

Partner API는 URL에서 버전이 지정됩니다. 현재 버전은 다음과 같습니다.

https://partner-api.performancehub.co/partner/v1/

변경 정책

Performance Hub는 가능한 한 추가 방식의 하위 호환 변경을 적용하는 것을 목표로 합니다.

하위 호환 변경의 예:

• 요청에 새로운 선택적 필드 추가.
• 응답에 새 필드 추가.
• 새 엔드포인트 추가.
• 클라이언트가 알 수 없는 값을 처리할 것으로 예상되는 경우 새 enum 값 추가.
• 상태 코드 계약을 변경하지 않고 유효성 검사 메시지 개선.

access_time_windows와 access_time_windows_revision은 추가된 회원 요청 필드입니다. 이 필드를 생략하는 기존 클라이언트는 저장된 Access Time Window 스냅샷이 변경되지 않은 상태로 유지됩니다. 이 생략 규칙은 부분 업서트 호환성을 유지하며, 생략은 빈 배열을 보내는 것과 같지 않습니다.

호환성이 깨지는 변경의 예:

• 필드 제거 또는 이름 변경.
• 필드 유형 변경.
• 선택적 요청 필드를 필수로 변경.
• 엔드포인트 제거.
• 기존 상태 코드 또는 도메인별 reason의 의미 변경.

사용 중단

호환성이 깨지는 변경이 필요한 경우 Performance Hub는 가능한 한 기존 버전을 그대로 변경하지 않습니다. 대신 새 버전이나 마이그레이션 경로를 도입하고 영향을 받는 파트너에게 변경 사항을 알립니다.

사용 중단 공지에는 다음이 포함될 수 있습니다.

• 변경 로그 항목.
• 파트너에게 직접 연락.
• Partner Console의 참고 사항.
• 문서의 마이그레이션 지침.

클라이언트 권장 사항

추가 방식의 변경을 허용하는 클라이언트를 구축하십시오.

• 사용하지 않는 응답 필드는 무시하십시오.
• 알 수 없는 enum 값은 충돌을 일으키지 말고 지원되지 않는 값으로 처리하십시오.
• 엄격한 응답 일치 검사는 피하십시오.
• 통합을 의도적으로 업데이트할 수 있도록 인식되지 않은 값을 기록하십시오.

Access Time Windows와 같이 리비전이 관리되는 회원 파티션의 경우 결과를 알 수 있을 때까지 제출한 리비전과 정규화 페이로드를 보존하십시오. 변경된 콘텐츠에 리비전을 다시 사용하면 충돌이 발생하며, 같은 콘텐츠를 재전송하면 멱등하게 처리됩니다. Access Time Windows를 참조하십시오.

OpenAPI 사양

게시된 OpenAPI 사양을 사용하여 클라이언트를 생성하고, 요청을 검증하고, 시간 경과에 따른 API 형태 변경을 추적하십시오.

OpenAPI 사양을 참조하십시오.