FlashDesk SDK ガイド

SDK の概要

FlashDesk SDK は、既存の管理画面、顧客ポータル、サポート画面に リモート接続機能を組み込みたい場合に使います。

前提条件

• 管理画面で SDK API キーを発行できること
• 接続したい Host がオンラインであること
• Host の FlashDesk ID が分かっていること。例: 12345678
• 開発者が用意した自社バックエンドのセッショントークン取得 URL があること

ステップ 1. SDK API キーを発行する

まず管理画面で SDK API キーを発行します。自社バックエンドはこのキーを使って FlashDesk のセッション発行 API を呼び出します。

ステップ 2. 自社バックエンドでセッショントークンを取得する

ブラウザから FlashDesk API を直接呼ぶのではなく、 自社バックエンドが内部で POST /api/sdk/viewer-session を呼び、 返ってきたセッション JSON を Viewer に返す構成にしてください。

呼び出し先 API

リクエストボディ

Node.js の例

app.get("/api/flashdesk/session-token", async (req, res) => {
  const hostId = req.query.hostId;
  const password = req.query.password || "";

  const response = await fetch("https://flashdesk.io/api/sdk/viewer-session", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      hostId,
      apiKey: process.env.FLASHDESK_SDK_API_KEY,
      password
    })
  });

  const json = await response.json();
  res.status(response.status).json(json);
});

Python / FastAPI の例

from fastapi import FastAPI
import httpx
import os

app = FastAPI()

@app.get("/api/flashdesk/session-token")
async def issue_flashdesk_token(hostId: str, password: str = ""):
    async with httpx.AsyncClient(timeout=10) as client:
        response = await client.post(
            "https://flashdesk.io/api/sdk/viewer-session",
            json={
                "hostId": hostId,
                "apiKey": os.environ["FLASHDESK_SDK_API_KEY"],
                "password": password
            }
        )
    return response.json()

ステップ 3. ブラウザで接続する

ブラウザでは flashdesk-viewer.js を読み込み、 自社バックエンドのセッショントークン取得 URL から新しいトークンを受け取って接続します。

SDK ファイル

flashdesk-viewer.js をダウンロードして、自社のウェブサーバーに配置してください。

実際の接続動作を確認したい場合は、デモページを別タブで開いて試せます。

ブラウザ側の最小例

<script src="flashdesk-viewer.js"></script>
<div id="viewer" style="width:100%;max-width:960px;height:540px;background:#000;"></div>
<script>
  const viewer = new FlashDeskViewer({
    element: document.getElementById("viewer")
  });

  viewer.setTokenProvider(async () => {
    const response = await fetch("/api/flashdesk/session-token?hostId=12345678");
    if (!response.ok) throw new Error("Failed to issue session token");
    return await response.json();
  });

  viewer.connect();
</script>

最小構成サンプル

Node.js と静的 HTML を使った最小構成の例です。

project/
  server.js
  .env
  public/
    index.html
    flashdesk-viewer.js

FLASHDESK_SDK_API_KEY=FDSDK-xxxxxxxxxxxxxxxx
HOST_ID=12345678

API リファレンス

POST /api/sdk/viewer-session

ブラウザ SDK 用のセッションを発行します。

GET /api/sdk-api-keys

現在の SDK API キー一覧を取得します。

POST /api/sdk-api-keys

新しい SDK API キーを発行します。

POST /api/sdk-api-keys/{id}/revoke

既存の SDK API キーを無効化します。

Webhook とセッションログ

GET /api/org-session-audits

誰が、いつ、どの Host に接続・切断したかを取得できます。

GET /api/sdk-webhooks

現在の Webhook 設定一覧を取得します。

POST /api/sdk-webhooks

新しい Webhook を作成します。

PATCH /api/sdk-webhooks/{id}

Webhook の有効状態や対象イベントを更新します。

エラーコード一覧

セキュリティ上の注意

• SDK API キーはブラウザへ直接渡さず、自社バックエンドだけで保持してください。
• 接続可能な Host を明確にし、意図しない接続先へ広げないでください。
• セッショントークン取得 URL は HTTPS で公開してください。
• 不要になった SDK API キーは管理画面ですぐに無効化してください。
• セッションログを確認し、意図しない接続が無いか定期的に監査してください。