Integration Options: UI, SDK, and API

This guide assists integration developers in connecting the Air Doctor Doctor App to their platforms via UI components, SDK methods, and APIs.

Integrating Air Doctor into Hospital Systems

Integration Options

Combine approaches, for example, use UI Screens for frontend speed and APIs for backend logic.

UI Screens
SDK
API

UI Screens

Provide prebuilt login, booking, and session flows.
Enable rapid UI integration with minimal development.
Ideal for organizations prioritizing speed over customization.

Integration Flow with UI Screens

UI Screens (prebuilt flows)
    ↓
Server APIs (for persistence, logs)

Responsibilities (UI)

Action	UI Screens
Log in	Provided screen
View appointments	Provided screen
Book appointment	Provided screen
Upload documents	Provided screen
Logging outcome	Not handled by UI Screens
Flow customization	Not supported

SDK

Runs on Web, Android, iOS.
Includes methods: signIn(), getAppointments(), bookAppointment(), uploadDocument().
Bridges frontend actions with server APIs.

Integration Flow with SDK

Client Frontend (custom UI)
    ↓
SDK methods
    ↓
Server APIs

Responsibilities (SDK)

Action	SDK Method
Log in	`signIn()`
View appointments	`getAppointments()`
Book appointment	`bookAppointment()`
Upload documents	`uploadDocument()`
Log session outcome	Use server API directly
Flow customization	Partial support via SDK

API

Access REST endpoints directly: authentication, appointments, documents, logs.
Requires building your own UI and wiring custom workflows.
Offers maximum control and flexibility.

Integration Flow with API

Client Frontend (custom UI)
    ↓
HTTP requests to Server APIs

Responsibilities (API)

Action	Your Implementation
Log in	Call `/login` endpoint
View appointments	`GET /appointments`
Book appointment	`POST /appointments`
Upload documents	`POST /documents`
Log session outcome	`POST /logs`
Flow customization	Full control over UI and logic

Integration Patterns

Use these patterns to streamline your workflow:

Pattern	Sequence	Best Use
Quick Launch + Logging	UI → API	Fast deployment with backend logging.
Embedded Flow	SDK → API	Build consistent UI flows that link to your backend.
Full Custom	API Only	Develop everything — UI and backend logic — in-house.

Use Case Example: Insurance Portal

Integration layers: Use UI Screens for ready-made booking flows, the SDK for embedded session logic, and the API for backend data exchange with hospitals and EHR systems.

Integration sequence:

UI Screens - Supply login and booking workflows. SDK - Drives behavior within partner’s app. API - Connects partner backend to Air Doctor for processing bookings, documents, and logs.