Developer guide · API v1

Integrate with your website

LAN Device Bridge lets websites call LAN device APIs after user approval. The website does not manage device passwords.

Websites receive API responses only for approved devices and scopes. They cannot elevate their own permissions or read device passwords.

1. Add the SDK to your project

Copy lan-device-bridge.js into your website source and import it locally. Avoid importing directly from this domain to prevent CORS dependencies and unexpected version changes.

JavaScript / TypeScript example

import { lanDeviceBridge } from './lan-device-bridge.js';

const listed = await lanDeviceBridge.listDevices();
if (!listed.ok || listed.data.length === 0) {
  // Show instructions: install the extension, add a device and grant this origin access.
  showBridgeHelp();
  return;
}

const device = listed.data[0];
const access = await lanDeviceBridge.getAccess(device.id);
if (access.data.scope !== 'full_api') {
  // Guide: click the extension icon → choose a device → Full Device API → reload.
  showPermissionHelp(device.name);
  return;
}

const response = await lanDeviceBridge.call({
  deviceId: device.id,
  method: 'GET',
  path: device.vendor === 'hikvision'
    ? '/ISAPI/System/deviceInfo'
    : '/cgi-bin/magicBox.cgi?action=getDeviceType'
});

if (!response.ok) throw new Error(response.error.message);
if (!response.data.ok) throw new Error(`Device returned HTTP ${response.data.status}`);
console.log(response.data.text);

2. Recommended UI flow

Check the bridge

Call listDevices(). If there is no response, show setup instructions instead of retrying continuously.

Choose a device

Only show devices the website is permitted to see. Store deviceId in the app configuration if needed.

Check the scope

Call getAccess(deviceId) before write operations. If access is missing, direct the user to the extension popup.

3. API contract

Function	Result
`listDevices()`	Devices visible to the website; excludes passwords.
`getAccess(deviceId)`	Scope: `none`, `read` or `full_api`.
`call({ deviceId, method, path, headers, body })`	The response contains `status`, `text` and `contentType`.

4. Integration rules

Do not request, store, log or send device credentials from the website.
Do not retry indefinitely on BRIDGE_NOT_AVAILABLE, OPERATION_NOT_ALLOWED or network errors.
Check both the bridge response and response.data.status; HTTP 200 does not always mean the operation succeeded.
Only request Full Device API when the feature requires methods beyond GET/HEAD.

5. Coding assistant prompt

Replace the bracketed sections, then paste the prompt into your coding assistant.

Integration prompt

Integrate LAN Device Bridge API v1 into my existing website.

Goal: [describe the feature that needs Dahua/Hikvision APIs].
Stack: [React/Vue/Next.js/plain HTML/etc.].
Device APIs: [list HTTP methods, paths and payloads].

Requirements:
1. Do not request, store, log or send device credentials from the website. Credentials are managed by the extension.
2. Copy lan-device-bridge.js into the website source and import it locally.
3. Use lanDeviceBridge.listDevices() to list devices approved for this website.
4. Before operations requiring elevated access, call lanDeviceBridge.getAccess(deviceId). If the scope is not full_api, direct the user to click the LAN Device Bridge icon in Edge, select the device, grant Full Device API to the current origin and reload. Websites cannot grant or elevate their own access.
5. Call APIs using lanDeviceBridge.call({ deviceId, method, path, headers, body }).
6. Handle BRIDGE_NOT_AVAILABLE, ORIGIN_NOT_ALLOWED, OPERATION_NOT_ALLOWED, DEVICE_NOT_FOUND, DEVICE_UNREACHABLE and response.data.status explicitly.
7. Do not retry indefinitely; provide a user-triggered retry button.
8. Create a bridge service/module and UI states for missing extension, missing access, no devices, connecting, errors and success.
9. Keep changes focused and compatible with the existing codebase, and list changed files.

SDK:
import { lanDeviceBridge } from './lan-device-bridge.js';
const list = await lanDeviceBridge.listDevices();
const access = await lanDeviceBridge.getAccess(deviceId);
const result = await lanDeviceBridge.call({ deviceId, method: 'GET', path: '/...' });

Inspect the project structure first, identify the files to change, then implement the integration.