<aside> 💡 Date: 2025-02-06

API의 신규 버전 v3 엔드 포인트가 추가되었으며, v2와 비교하여 몇 가지 중요한 변경 사항이 포함되어 있습니다. 각 버전은 별도로 유지되며, 기존 v2와 신규 v3의 차이점은 다음과 같습니다.

1. API 경로 및 버전 헤더 변경

1.1 올바르지 않은 API 요청 처리

1. v2, v3 외 다른 경로로 요청하는 경우 응답 코드 400 Bad Request와 함께 아래 오류 메세지가 반환 됩니다:

   {
       "message": "Invalid API version path"
   }
   
   

2. 경로와 버전이 일치하지 않는 경우 응답 코드 400 Bad Request와 함께 아래 오류 메세지가 반환 됩니다:

   {
       "message": "Invalid API version header"
   }
   
   

3. v3 API key로 v2 경로에 접근하는 경우 응답 코드 403 Forbidden와 함께 아래 오류 메세지가 반환 됩니다:

   {
       "message": "You do not have access to API version 'v2'"
   }
   
   

2. API별 변경 사항

2.1 v2와 v3의 주요 차이점

2.2 주문 API

• 엔드 포인트:
  • POST /v3/orders (주문 생성)
  • PUT /v3/orders (주문 수정)
• 변경된 매개 변수 검증:
  • 영향 받는 필드:
    • ordererPhoneNo: 주문자의 일반 전화 번호
    • ordererMobileNo: 주문자의 휴대폰 번호
    • receiverPhoneNo: 수령자의 일반 전화 번호
    • receiverMobileNo: 수령자의 휴대폰 번호
  • 전화번호 형식 요구 사항:

    • 반드시 E.164 형식이어야 합니다.

    • 잘못된 전화번호 형식으로 요청 시 응답 코드 400 Bad Request와 함께 아래 오류 메세지가 반환 됩니다:

      {
          "message": "invalid phone number. please use E.164 format"
      }
      
      

3.3 영상 iframe 호출 API

• 엔드포인트: GET /v3/videos/{videoCode}/embed
• 변경 사항:
  • 205 Reset Content 응답 코드가 제거되었습니다.
  • 성공 시 200 OK 응답만 반환합니다.

3. 유의 사항

• 각 API 호출 시 해당 버전에 맞는 경로와 버전 헤더를 사용해주시기 바랍니다.
• v2에서 v3로 전환하는 경우 주문 관련 API 요청 전에 전화번호 형식이 E.164 형식인지 반드시 검증해주시기 바랍니다.
• v2에서 v3로 전환하는 경우 영상 iframe 호출 API에서 205 Reset Content 응답을 기대하는 로직이 있다면 205 Reset Content 응답은 더 이상 지원하지 않으므로 200 OK 로 수정해주시기 바랍니다. </aside>