ファイル送受信の手順(デバイス側)

[更新: 2022年3月24日]

1. 概要

デバイス側におけるファイル送受信の手順を説明します。 以下のような2〜3段階の手順が必要です。

  1. ファイル送信(または受信)要求をモノプラットフォームに送る
  2. モノプラットフォームから、送信(または受信)用のURLが返却される
    • 返却されたURLに対して、あらためてファイル本体を送信(または受信)
  3. 送信完了通知をモノプラットフォームに送る(送信時のみ)

注意

  • エンドポイントURLには、さくらのモノプラットフォームのプロジェクトに登録したセキュアモバイルコネクトのSIMを通してのみアクセスできます。

2. ファイル送信

  1. 送信要求用のエンドポイントに、HTTPにて送信要求を送ります。
    • エンドポイントURL: https://file.sipf.iot.sakura.ad.jp/v1/files/FILENAME/
      • FILENAME には送受信に使うファイル名を指定してください
      • ファイル名の仕様については、 ファイル送受信機能について の「ファイル送受信における制限」を参照ください
    • リクエストメソッド: PUT
    • クエリストリング: なし
    • リクエストボディ: なし
    • レスポンスボディ: ファイル本体送信用のURL
      • レスポンスボディにはURLのみが含まれています
  2. 上記のレスポンスボディに含まれているファイル本体送信用のURLに対し、HTTPにてファイル本体を送ります。
    • リクエストメソッド: PUT
    • クエリストリング: なし
    • リクエストボディ: ファイル本体
  3. 送信完了通知用のエンドポイントに、HTTPにてあらためて送信完了通知を送ります。

注意

  • ファイル本体送信用のURLには有効期限がありますので、同じURLを使いまわさないでください。
  • 最後の送信完了通知を送らないと受信できる状態となりませんのでご注意ください。
  • ファイルは名前で識別されます。すでに存在しているファイル名と同じ名前でファイルを送信した場合、すでに存在しているファイルは上書きされます。
  • 送信側がつけたファイル名はオブジェクト送受信機能で受信側に通知するか、事前に決めておく必要があります。

2. ファイル受信

  1. 受信要求用のエンドポイントに、HTTPにて受信要求を送ります。
    • エンドポイントURL: https://file.sipf.iot.sakura.ad.jp/v1/files/FILENAME/
      • FILENAME には送受信に使うファイル名を指定してください
      • ファイル名の仕様については、 ファイル送受信機能について の「ファイル送受信における制限」を参照ください
    • リクエストメソッド: GET
    • クエリストリング: なし
    • レスポンス形式: text/plain
    • レスポンスボディ: ファイル本体受信用のURL
      • レスポンスボディにはURLのみが含まれています
  2. 上記のレスポンスボディに含まれているファイル本体受信用のURLに対し、HTTPにてファイル本体の受信要求を送ります。
    • リクエストメソッド: GET
    • クエリストリング: なし
    • レスポンスボディ: ファイル本体

注意

  • ファイル本体受信用のURLには有効期限がありますので、同じURLを使いまわさないでください。
  • 送信されたファイルには、送信元の区別はありません。そのため、送信元の種類(デバイス・アプリケーション)にかかわらずデバイス側では同様の方法で受信可能です。