メインコンテンツまでスキップ

Miniviz APIリファレンス(画像)

Miniviz APIは、以下のエンドポイントをサポートしています。

APIエンドポイント

画像送信API

POST https://api.miniviz.net/api/project/{project_id}/image?token={token}

リクエスト概要

Miniviz API への画像送信は POST メソッドを使用します。送信ボディは JSON 形式です。画像データは base64 エンコードして送信します。

リクエストボディ(画像送信)

フィールド名必須説明
timestampnumberYes送信時刻(UNIX 時間ミリ秒)
label_keystringYesデバイス名や設置場所など、送信元を識別するラベル(128文字以内、[A-Za-z0-9-_.:@/]のみ)
image_namestringYes画像ファイル名(255文字以内)
image_base64stringYesbase64エンコードされた画像データ(200KBまで)

制限事項

画像サイズと形式

  • 画像サイズ: 1枚あたり200KBまで(base64エンコード後のサイズ)
  • 対応形式: JPEG、PNGのみ
  • 送信周期: 60秒/枚(ラベルキー別に管理)
  • 保存期間: 30日間(※)

※エクスポート機能は2025年12月末頃に公開予定です。

プラン制限

  • 利用可能プラン: Proプランのみ(無料プランでは403エラー)

リクエスト例(画像送信)

{
"timestamp": 1717587812345,
"label_key": "camera_1",
"image_name": "image.jpg",
"image_base64": "base64_encoded_image_data"
}

curlコマンド(Linux/MacOS)


timestamp_ms=$(( $(date -u +%s) * 1000 ))

# 画像ファイルをbase64エンコード
image_base64=$(base64 -i image.jpg)

curl -X POST \
"https://api.miniviz.net/api/project/{project_id}/image?token={token}" \
-H "Content-Type: application/json" \
-d "{
\"timestamp\": ${timestamp_ms},
\"label_key\": \"camera_1\",
\"image_name\": \"image.jpg\",
\"image_base64\": \"${image_base64}\"
}"

画像の確認

データベースページから送信された画像をプレビューすることができます。

画像の確認

画像の確認

また、グラフ作成ページから画像をグラフに表示することもできます。

[新しいグラフ作成] -> [グラフの種類を選択] -> [image]を選択

画像のグラフ作成