Quick Start

Unveily supports Android (7.0+ / API 24) and iOS at feature parity. The steps below are the Android quick start; for iOS see the iOS Quick Start section.

Move faster with an AI assistant

Most of the setup and edits below can be accelerated with an AI assistant like Claude, Gemini, or ChatGPT.

Edit files: paste your whole MainActivity.kt or config.json and say "my domain is example.com, the features I use are QR and push" to get an edited version back.
Generate bridge code: ask for something like "JavaScript that opens a QR scan via unveilyBridge and receives the result" to get a working example.
Diagnose errors: paste the full build/run error message to get the cause and a fix.

Always double-check generated output against this documentation.

Android — Prerequisites

Android Studio Hedgehog (2023.1.1) or later
JDK 17 or later
A subscription plan (Basic / Standard / Pro)
A license key (check your dashboard under My Page → License)

Go to My Page → Downloads and download the ZIP file for your subscription plan.

unveily-android-basic-1.0.0.zip      # Basic plan
unveily-android-standard-1.0.0.zip   # Standard plan
unveily-android-pro-1.0.0.zip        # Pro plan

2. Open in Android Studio

Unzip the downloaded file
In Android Studio, go to File → Open and select the unzipped folder
Wait for the Gradle sync to complete

3. Required Settings (3 items)

3-1. Set the WebView URL

In app/src/main/java/.../MainActivity.kt:

// Before
const val TRUSTED_WEB_URL = "https://example.com"

// After (replace with your domain)
const val TRUSTED_WEB_URL = "https://your-domain.com"

3-2. License Key File

Save the license key you received from My Page as a file:

app/src/debug/assets/license.key    ← Development license key
app/src/release/assets/license.key ← Production license key

The app will not start if the license key file is missing.

3-3. Firebase Setup

Create a project in the Firebase Console and download google-services.json.

app/google-services.json  ← Place it here

4. Build & Run

# Debug build (uses development license)
./gradlew :app:assembleBasicDebug

# Release build (uses production license)
./gradlew :app:assembleBasicRelease

Before doing a Release build, make sure you complete the production license activation.

iOS Quick Start

The iOS SDK builds with Xcode. Follow the iOS Configuration Guide for the full setup; the minimal flow is below.

iOS — Prerequisites

Xcode 15 or later (macOS)
XcodeGen (brew install xcodegen)
An Apple Developer account (Team ID)
A subscription plan and license key

1. Generate the Project

Generate the Xcode project from the downloaded unveily-sdk-ios-{plan} folder.

cd unveily-sdk-ios-pro
xcodegen generate
open *.xcodeproj

2. Required Settings

project.yml: set PRODUCT_BUNDLE_IDENTIFIER, DEVELOPMENT_TEAM, and UnveilyInitialURL (your web domain) to your own values, then re-run xcodegen generate
UnveilyApp/Supporting/license.key: place the license key from your dashboard (activation is bound to Bundle ID / Team ID)
GoogleService-Info.plist: download from Firebase and replace the .template file
Info.plist: add the usage-description keys for the features you use (NSCameraUsageDescription, NSFaceIDUsageDescription, NSLocationWhenInUseUsageDescription, etc.)
In-app purchase (Pro): create product IDs in App Store Connect — the SDK handles purchases via StoreKit 2

3. Run

In Xcode, select a device or simulator and run Product → Run. To ship, use Product → Archive → Distribute App → App Store Connect.

The full project structure, social login, and entitlements setup are covered in detail in the iOS Configuration Guide.