<aside> 💡 Date: 2025-02-06
API의 신규 버전 v3 엔드 포인트가 추가되었으며, v2와 비교하여 몇 가지 중요한 변경 사항이 포함되어 있습니다. 각 버전은 별도로 유지되며, 기존 v2와 신규 v3의 차이점은 다음과 같습니다.
API 경로 | Version |
---|---|
https://api.realpacking.com/v3 | 2025-01-09 |
https://api.realpacking.com/v2 | 2024-01-02 |
v2, v3 외 다른 경로로 요청하는 경우 응답 코드 400 Bad Request
와 함께 아래 오류 메세지가 반환 됩니다:
{
"message": "Invalid API version path"
}
경로와 버전이 일치하지 않는 경우 응답 코드 400 Bad Request
와 함께 아래 오류 메세지가 반환 됩니다:
{
"message": "Invalid API version header"
}
v3 API key로 v2 경로에 접근하는 경우 응답 코드 403 Forbidden
와 함께 아래 오류 메세지가 반환 됩니다:
{
"message": "You do not have access to API version 'v2'"
}
v2 | v3 | |
---|---|---|
주문 생성, 수정 API 호출 시 전화번호 형식 | 제한 없음 | E.164 형식 필수 |
영상 iframe 호출 API 성공 시 http status code | 200 OK , 205 Reset Content |
200 OK 만 지원 |
POST /v3/orders
(주문 생성)PUT /v3/orders
(주문 수정)ordererPhoneNo
: 주문자의 일반 전화 번호ordererMobileNo
: 주문자의 휴대폰 번호receiverPhoneNo
: 수령자의 일반 전화 번호receiverMobileNo
: 수령자의 휴대폰 번호반드시 E.164 형식이어야 합니다.
잘못된 전화번호 형식으로 요청 시 응답 코드 400 Bad Request
와 함께 아래 오류 메세지가 반환 됩니다:
{
"message": "invalid phone number. please use E.164 format"
}
GET /v3/videos/{videoCode}/embed
205 Reset Content
응답 코드가 제거되었습니다.200 OK
응답만 반환합니다.205 Reset Content
응답을 기대하는 로직이 있다면 205 Reset Content
응답은 더 이상 지원하지 않으므로 200 OK
로 수정해주시기 바랍니다.
</aside>