Circadify

Installation

Install the Circadify Web SDK for JavaScript and TypeScript. Contactless vital signs from a browser camera.

The Circadify Web SDK is distributed as a private npm package on the Circadify SDK registry at sdk.circadify.com. Authorized customers install it with npm install @circadify/web-sdk after a one-time .npmrc setup, authenticated with a single Circadify SDK access token — the same token that installs the iOS and Android SDKs.

Get registry access

@circadify/web-sdk is a private package -- you need a Circadify SDK access token before you can install it. No GitHub account or PAT is involved.

  1. Request SDK access in the developer portal. Sign in at developer.circadify.com and request SDK access. After your enterprise agreement is signed, support approves the request and confirms by email.

  2. Get your Circadify SDK access token from the developer portal under Integrate → SDK Access. This single token authenticates the package download for the Web, React, iOS, and Android SDKs. It is distinct from your ck_live_/ck_test_ API key — the access token downloads the package, the API key runs the SDK at runtime.

  3. Configure npm by creating a project-level .npmrc next to your package.json:

    .npmrc
    @circadify:registry=https://sdk.circadify.com/npm/
//sdk.circadify.com/npm/:_authToken=${CIRCADIFY_TOKEN}
always-auth=true
    ini

  4. Export the token so npm picks it up at install time:

    export CIRCADIFY_TOKEN=your_circadify_sdk_access_token
    bash

This tells npm that anything under the @circadify scope is fetched from the Circadify SDK registry with your access token; every other package continues to come from the public npm registry. The always-auth=true line ensures npm sends the token on tarball fetches as well as the metadata request.

Caution

Never commit a literal token. Use the ${CIRCADIFY_TOKEN} env-var indirection above, or add .npmrc to .gitignore if it must contain a literal value. To rotate or revoke access (e.g. if an engineer leaves), rotate the token in the developer portal under Integrate → SDK Access, or email support@circadify.com.

Tip

For CI/CD, store the access token as a secret (e.g. CIRCADIFY_TOKEN) and reference it from .npmrc. The same .npmrc layout works on every npm-compatible package manager.

Package Manager

Once the registry is configured and your token is exported, install @circadify/web-sdk with your preferred package manager. The SDK ships as ESM with a CommonJS fallback.

Install with npm — the default Node.js package manager.

npm install @circadify/web-sdk
bash

Requirements

  • Bundle size: ~38 KB (ESM core). Runtime assets are lazy-loaded on first use and cached by the browser.
  • HTTPS: Required for camera access. localhost works during development.
  • Browser support:
BrowserMinimum Version
Chrome80+
Firefox75+
Safari14+
Edge80+
  • Required browser APIs:
APIPurpose
WebAssemblySDK runtime support
Web WorkersBackground measurement support
MediaDevices (navigator.mediaDevices)Camera stream access
WebGL (optional)Hardware-accelerated browser rendering support; falls back to Canvas 2D

TypeScript Support

The SDK ships with full TypeScript definitions included. No additional @types package is needed.

import {
  CircadifySDK,
  CircadifyError,
  CircadifyErrorCode,
  type CircadifyConfig,
  type VitalSignsResult,
  type ProgressEvent,
  type QualityWarning,
} from '@circadify/web-sdk';
typescript

All public interfaces, callback signatures, and error types are exported. TypeScript 4.7 or later is recommended for full ESM support.

Next Steps