<aside> 💡

Date: 2025-09-14

v3 APIに新規バージョンが追加され、「送信ページ URL 作成API」の共通動作方式が変更されました。今回のアップデートの詳細は以下の通りです。

1. [v2, v3 共通]「送信ページ URL 作成API」の動作方式の変更

「送信ページ URL 作成API」のコアロジックが変更され、今後は呼び出しのたびに常に新しい送信ページのURLを生成するようになります。

• 主な変更点
  • 従来は、既存のvideoCodeでURL生成をリクエストした場合、URLの存在有無を検証し、409 Conflictエラーを返していました。
  • 今回のアップデートで、この検証ロジックは削除されました。これにより、videoCodeが重複しているかどうかに関わらず、常に新しいURLが生成・返却されます。
• 影響
  • URLの存在確認のために409 Conflictエラーを期待するロジックを実装している場合、そのロジックは今後機能しなくなるため、修正が必要です。

2. [v3] 新規APIバージョン（2025-09-14）の追加および変更点

v3 APIのヘッダーにVersion: 2025-09-14を指定することで、以下の新機能および変更点が適用されます。

• 2.1 新規APIの追加：映像再生URL照会API
  • 特定の映像のソースリンクを直接照会できるAPIが追加されました。このAPIは、プレイヤーを含むiframeの代わりに、再生可能な映像のURL自体を返します。
  • 詳細な使用方法については、「映像再生URL照会APIドキュメント」をご参照ください。
• 2.2 既存APIの変更点
  • 送信ページ URL 作成API
    • Version: 2025-09-14を使用する場合、リクエスト（Request）とレスポンス（Response）の形式が変更されました。
  • 送信ページURL閲覧API
    • Version: 2025-09-14を使用する場合、リクエスト（Request）とレスポンス（Response）の形式が変更されました。

3. 注意事項

• v3 APIの新機能を利用する場合は、APIリクエストヘッダーのVersionの値を2025-09-14に設定する必要があります。
• 変更されたAPIを使用する前に、必ず関連APIドキュメントで新しいリクエストおよびレスポンスの形式をご確認ください。

</aside>

<aside> 💡

Date: 2025-06-05

送信ページ URL閲覧API が改善されました。

これまでは、created-after および created-before による 日付範囲のみで転送ページのURLを取得できましたが、

今回のアップデートにより、特定の映像撮影コード（video-code）による検索も可能になりました。

このAPIを使用する際は、日付範囲または映像撮影コードのいずれかを必ず指定してください。

両方が省略された場合、リクエストは失敗します。

APIの利用方法については、送信ページ URL閲覧APIドキュメントをご参照ください。

</aside>

<aside> 💡

Date: 2025-05-29

特定の映像を削除するAPIが追加されました。

使用方法の詳細については、映像の個別削除APIのドキュメントをご参照ください。

</aside>

<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: 注文者の電話番号
    • 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>