Skip to content

React Native SDK overview

The Abi React Native SDK brings Abi’s consultation experience into Android and iOS applications. It supports text and video consultations, prescription workflows where enabled, and partner-specific visual configuration.

Capability Product outcome
Modular consultations Enable text, video, prescription requests, and agreed mental-health evaluation flows.
End-to-end flow Support symptom capture, clinician interaction, answers, prescriptions, and summaries in one application journey.
Real-time communication Use REST and WebSocket connections for consultation lifecycle updates.
Configurable interface Adapt colors, typography, spacing, shadows, buttons, headers, doctor cards, modals, and consultation screens.
Localized delivery Support partner-defined languages and country-specific address capture where enabled.
Integration events Receive non-sensitive consultation events such as started, ended, and resolved.
Abi React Native SDK architectureA partner backend authenticates with Abi's REST API and returns a user token to the React Native application. The application gives the token to the Abi React Native SDK, which validates it with Abi's SDK service and receives real-time updates over a secure WebSocket connection.React Native AppReact NativeapplicationReact Native SDKAbiCloud service backendBackend servicesAbi platformSDK serviceToken validation and updatesAbiREST API (HTTPS)Abi5. REST API requestsauthenticated with a user token1. Authenticate2. Partner token issued after authentication2.1 Token is shared withthe SDK component3. Token validationexpires in 1 hour4. Secure WebSocketreal-time updatesHTTPS (secure)WebSocket (secure)Encrypted communicationAbiAbi component
The partner backend keeps credentials server-side and issues the user token that the React Native SDK needs.

Your backend authenticates with Abi and obtains a user token. The mobile app passes that token to the SDK; it must never contain a partner API key or other long-lived credential. The SDK validates the token, uses secure WebSocket connections for real-time consultation updates, and makes authenticated REST API calls as required by the consultation flow.

  1. Install the SDK and its native dependencies.
  2. Configure the required mobile permissions and build a native Android or iOS application.
  3. Add the consultation provider and components to the part of the app that hosts the experience.
  4. Use the REST API authentication guide to implement token issuance in your backend.
Requirement Detail
Platform React Native for Android and iOS
Native support Custom native modules; not Expo Go
Permissions Camera and microphone for video workflows
Connectivity Secure REST API and WebSocket access
Security User-token authentication and agreed transport controls

Start with the SDK quickstart or go directly to installation.