Release Note: APIバージョンアップデート及び変更内容 | Notion

<aside> 💡 Date: 2025-02-06

APIの新規バージョンV3エンドポイントが追加され、V2と比較していくつか重要な変更内容が含まれております。各バージョンは別途で維持され、既存のv2と新規のv3の相違点は次の通りです。

1. API経路及びバージョンヘッダー変更

API経路	Version
https://api.realpacking.com/v3	2025-01-09
https://api.realpacking.com/v2	2024-01-02

1.1 正しくないAPIリクエストの処理

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'"
}
```

2. API別変更内容

2.1 v2とv3の主な相違点

	v2	v3
注文作成、修正APIを呼び出す際の電話番号形式	制限なし	E.164形式必須
映像iframe呼出しAPIの成功時にhttp status code	`200 OK`, `205 Reset Content`	`200 OK`のみ対応可能

2.2 注文API

エンドポイント:
- POST /v3/orders (注文作成)
- PUT /v3/orders (注文修正)
変更された媒介変数の検証:
- 影響を受けるフィールド:
  - ordererPhoneNo: 注文者の電話番号
  - receiverMobileNo: 受取人の携帯電話番号
  - receiverPhoneNo: 受取人の電話番号
- 電話番号形式リクエスト:
  - 必ず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>