License

The BiosenseSignal SDK uses a licensing mechanism to protect against unauthorized usage, and to grant measurement permissions specified in the license agreement.

License Types

In Web, the only available license type is Session: Sessions

Using the License Key

A valid license key must be provided in order to initiate a measurement session or activate a user.

TypeScript

import healthMonitorManager, {
    FaceSessionOptions
} from '@biosensesignal/web-sdk';

await healthMonitorManager.initialize({
    licenseKey,  
});

const options: FaceSessionOptions = { 
    input: video.current,
    cameraDeviceId: cameraId,
    processingTime,
    onVitalSign,
    onFinalResults,
    onError,
    onWarning,
    onStateChange,
    onImageData,
};

const faceSession = await healthMonitorManager.createFaceSession(options);  

WARNING

The application must secure the license key and prevent it from being exposed to 3rd parties.

Receiving License Updates

The SDK sends a LicenseInfo data that contains:

• Offline Measurements Info - An object with information about offline measurements
• Activation ID - A string with the license activation id.

The application can receive license-related messages by implementing the LicenseInfo callback interface:

TypeScript

import { 
    OfflineMeasurements
} from '@biosensesignal/web-sdk';
  
const onOfflineMeasurement = useCallback(
  (offlineMeasurements: OfflineMeasurements) => {
      console.log(`License Offline Measurements: 
          ${offlineMeasurements.totalMeasurements}/
          ${offlineMeasurements.remainingMeasurements}`);
  },
  [],
);

const onActivation = useCallback((activationId: string) => {
    console.log(`License Activation ID: ${activationId}`)
}, []);

License Server Network Routing

The SDK connects with the license server at https://licensing-api.biosensesignal.com. The traffic to this server is routed through a Cloudflare service. Since Cloudflare is inaccessible in certain countries, a custom workaround is available for these regions. Contact our customer support if the license server is unreachable in your target territories.