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.
Architecture
Air Doctor uses a dynamic interface. The SDK calls the API, handles a wrapped JSON response, and renders pages with modular UI components.
| Layer | Role |
|---|---|
| API layer | Handles authentication, validation, and data storage via REST calls. |
| SDK layer | Connects iOS, Android, and web apps to the backend. It calls the API, handles wrapped JSON responses, and renders modular UI. |
| Client layer | Hosts Air Doctor screens using embedded UI or custom implementations. |
Request and Response Flow
| Request type | Purpose | Typical response |
|---|---|---|
| GET | Load a full page | PageResponse with all UI elements |
| PATCH | Update part of a page or component | PatchResponse with targeted updates |
| POST | Submit or save data (such as forms or uploads) | PostResponse indicating next steps |
Integration approaches
Choose or combine integration options Air Doctor into your platform:
- UI screens
- SDK
- API
Use prebuilt login, booking, and session workflows.
- Integrate quickly with minimal effort.
- Best for standard use cases.
UI screens (prebuilt flows)
↓
REST API (data persistence, logging)
Use the cross-platform SDK for iOS, Android, and web apps.
-
Offers authentication, booking, and document methods.
-
Supports customization with server-defined UI.
Custom frontend
↓
SDK methods
↓
REST API
Call Air Doctor’s REST API directly.
-
Get full control over interface and logic.
-
Ideal for advanced, fully custom setups.
Custom frontend
↓
Direct API calls
Integration option comparison
| Capability | UI Screens | SDK | API |
|---|---|---|---|
| UI provided | ✔ Prebuilt screens for login, booking, sessions | ✖ Custom UI required; SDK renders server-driven elements | ✖ Fully custom UI |
| Frontend customization | ✔ Included | ◑ Limited; controlled by server responses | ✔ Full control |
| Logic layer | Built-in | Included; SDK processes API responses | Developer-built |
| Backend integration | Built-in | Built-in | Developer-built |
| Booking workflows | ✔ Included | ✔ Included | ✔ Implement manually |
| Document handling | ✔ Included | ✔ Included | ✔ Implement manually |
| Authentication | ✔ Included | ✔ Included | ✔ Implement manually |
| Best for | Quick launch, standard flows | Apps needing some flexibility | Complex, custom solutions |
Use Case: Insurance Portal Integration
This scenario shows how to combine Air Doctor’s integration layers to support a partner insurance portal. Each layer addresses a specific part of the workflow:
- UI Screens: Deliver prebuilt login, booking, and session workflows to reduce front-end development.
- SDK: Acts as the client integration layer. It processes server-driven responses and renders UI elements inside the partner application.
- API: Provides backend integration for booking synchronization, document exchange, and logging with hospital or EHR systems.
This structure separates responsibilities, simplifies maintenance, and allows partners to select the level of control they need.
