Appearance

On this page

License ​

The Binah.ai SDK uses a licensing mechanism to protect against unauthorized usage, and to grant measurement permissions specified in Binah's license agreement.

License Types ​

Binah offers the license types:

  1. Active Users
  2. 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 { 
    SessionBuilder
} from 'binah-react-native-sdk'; 

try { 
    const session = await SessionBuilder.faceSession({licenseKey: LICENSE_KEY});
} catch (e) {
    const exception = (e as HealthMonitorException)
    console.log(`Error: ${exception?.code}`);
}

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 object that contains:

The application can receive license-related messages by using useLicenseInfo hook:

TypeScript
import { 
    useLicenseInfo
} from 'binah-react-native-sdk';

const licenseInfo = useLicenseInfo();

React.useEffect(() => {
    if (licenseInfo) {
        console.log(`License Activation ID: ${licenseInfo.activationInfo.activationId}`)
        if (licenseInfo.offlineMeasurements) { 
            console.log(`License Offline Measurements: 
                    ${licenseInfo.offlineMeasurements.totalMeasurements}/
                    ${licenseInfo.offlineMeasurements.remainingMeasurements}`);
        }
    }
}, [licenseInfo]);