TOSEIクラウド2 簡易マニュアル 管理画面を開く
連携ガイド 03

APIを使って実装する

公開APIから稼働状況をJSONで取得し、自社サイトのデザインに合わせて自由に表示できます。認証は不要で、ブラウザから直接呼び出せます。

店舗ホームページへの掲載
1

エンドポイント

GET https://toseicloud-admin-api.laundry-dx.jp/api/public/device-statuses/{StoreID}?sort=unit_no

認証は不要です。{StoreID} に店舗IDを指定して呼び出すと、 機器一覧と稼働状況が JSON 形式で返ります。 レスポンスの詳細は APIリファレンス(Swagger UI) で確認・お試しいただけます。

2

使う主なフィールド

result[] 配列の各要素が1台の機器に対応します。

フィールド意味
unit_no号機番号
connection_flg通信状態。false なら未接続
device_type_master.name機器種別(乾燥機 / 洗濯機 など)
device_model_master.product_number型番
device_model_master.device_sizeサイズ区分(S / M / L)
device_status.operation_status.code稼働コード。"1" が運転中
device_status.operation_status.name稼働状態の表示名(空き / 運転 など)
device_status.remaining_time残り運転時間(分)
3

稼働状態の判定ルール

  • 未接続connection_flg === false
  • 運転中connection_flg === true かつ operation_status.code === "1"
  • 空き上記以外
4

最小コード例

装飾を除いた「データ取得+表示」の最小例です。STORE_ID を変更し、 表示部分(innerHTML の内側)を自社のデザインに差し替えてください。

<div id="device-status">読み込み中…</div>

<script>
const STORE_ID = 10001;  // ← 店舗IDを指定
const API = `https://toseicloud-admin-api.laundry-dx.jp/api/public/device-statuses/${STORE_ID}?sort=unit_no`;

async function loadDeviceStatus() {
  const res = await fetch(API);
  const { result } = await res.json();

  document.getElementById("device-status").innerHTML = result.map(d => {
    const offline = !d.connection_flg;
    const running = d.connection_flg && d.device_status?.operation_status?.code === "1";
    const state = offline ? "未接続" : running ? "運転中" : "空き";
    const remain = (running && d.device_status.remaining_time > 0)
      ? `(残り${d.device_status.remaining_time}分)` : "";
    return `<li>${d.unit_no}号機 ${d.device_type_master?.name ?? ""}:${state}${remain}</li>`;
  }).join("");
}

loadDeviceStatus();
setInterval(loadDeviceStatus, 30000);  // 30秒ごとに更新
</script>
注意

実装時の注意点

  • サイトは HTTPS で配信してください(HTTP の場合、混在コンテンツとしてブロックされます)。
  • 本APIはブラウザから直接呼び出せます(CORS 許可済み)。サーバーを経由せず JavaScript から取得できます。
  • 更新間隔は 30秒程度を推奨します。短い間隔での連続呼び出しはお控えください。
  • 店舗名は API では取得できません。見出しなどで自社ページ側に表示してください。