Skip to content
Circadify Circadify Circadify

Installation

Requirements

Section titled “Requirements”
RequirementMinimum
iOS15.0+
macOS (Mac Catalyst)12.0+
Xcode14.0+
Swift5.7+
DevicePhysical device with front camera

Install via Swift Package Manager

Section titled “Install via Swift Package Manager”

  1. In Xcode, go to File > Add Package Dependencies…

  2. Enter the repository URL:

    https://github.com/circadify/circadify-ios-sdk

  3. Select Up to Next Major Version and set the minimum to 1.0.0.

  4. Click Add Package and add CircadifySDK to your target.

Or add it directly to your Package.swift:

dependencies: [
    .package(url: "https://github.com/circadify/circadify-ios-sdk", from: "1.0.0")
]

Camera Permission

Section titled “Camera Permission”

Add the camera usage description to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>This app uses the camera to measure your vital signs contactlessly.</string>

Without this entry, iOS will terminate your app when the SDK attempts to access the camera.

Verify Installation

Section titled “Verify Installation”
import CircadifySDK


let sdk = try CircadifySDK(apiKey: "ck_test_your_key_here")
print("SDK initialized")

If this compiles and runs without error, the SDK is installed correctly.

Get an API Key

Section titled “Get an API Key”

Sign up at developer.circadify.com to create API keys. Use ck_test_* keys during development and ck_live_* keys in production.

Next Steps

Section titled “Next Steps”