Quick Start

Use this guide to integrate the Air Doctor platform into your healthcare or insurance application. Select an integration level that aligns with your architecture, development resources, and customization goals.

Prerequisites

Confirm the following before you begin:

Valid SDK token or API key.
Partner sandbox credentials.
Node.js (version 16 or later).
Package manager (npm or yarn) for SDK usage.
OpenAPI-compatible tooling (if using Level 6).

Step 1: Choose Integration Level

The Air Doctor platform supports six integration levels. Start with the approach that best fits your product maturity, frontend stack, and time-to-market expectations.

Level	Description	Requirements
1	Forward users to the Air Doctor app.	No development required.
2	Embed the full Air Doctor app within your app.	Support for WebView or iframe.
3	Embed with custom styling using scoped CSS.	Ability to isolate and override theme styles.
4	Use Air Doctor frontend components with the integrated SDK.	React support and light setup.
5	Build a custom frontend using the Air Doctor backend SDK.	React/JavaScript stack and familiarity with SDK APIs.
6	Integrate directly with the backend using the OpenAPI specification.	Java, Kotlin, or backend stack that supports OpenAPI clients.

All levels preserve routing, authentication, and session state handling. Only Levels 5 and 6 provide full layout and flow control.

Step 2: Install the SDK

Install the SDK package in your project:

npm install @air-doctor/sdk
# or
yarn add @air-doctor/sdk

Initialize the SDK:

import AirDoctorSDK from '@air-doctor/sdk';

const sdk = new AirDoctorSDK({
  apiKey: '<your-api-key>',
  environment: 'sandbox', // Use 'production' in live environments.
});

Step 3: Update UI Based on Session State

Update your interface based on SDK session status:

if (sdk.hasValidSession()) {
  showBookAppointmentButton();
} else {
  showLoginForm();
}

This logic ensures users only see actions relevant to their authenticated session.

Step 4: Option for Custom Integration via API

For full customization, generate a client from the OpenAPI schema and connect your backend services. This enables advanced flows such as:

Session and user management.
Appointment search and scheduling.
Uploading visit documents and notes.

To get started, see the API Reference documentation.

Architecture Overview

+-------------------+       +--------------------+       +------------------+
|                   |       |                    |       |                  |
|   Your Front End  +------>+ Air Doctor SDK/API +------>+ Air Doctor Server|
|                   |       |                    |       |                  |
+-------------------+       +--------------------+       +------------------+
        |                            |                             |
        |<---------------------------+                             |
        |     Appointment Data       |                             |
        |                            |<----------------------------+
        |                            |     Confirmation/Updates    |