Healthie's API & SDKs
Healthie is an API-first company and our API product is the same that our own front-end developers use to build our web and mobile apps. Here is an overview of our features available through the API.
Our API is an available add-on for members on our Enterprise Plan.
Healthie offers a closed API that enables you to tap into the back-end of the HIPAA and SOC 2-compliant software platform. You can request API docs here: https://www.gethealthie.com/api-overview
IN THIS ARTICLE:
About Healthie's API
- Healthie's API processes tens of millions of requests a month, across hundreds of thousands of active users.
- Healthie's API is backwards compatible. As Healthie updates the API and platform, your API access is automatically updated.
- Healthie's API utilizes GraphQL. Healthie is built on Ruby / Post Gres, React, React Native, Swift, Java.
- It is possible to have one webhook hitting multiple endpoints if needed.
Security and Privacy
Here is some information on Healthie's Security and Privacy
- Healthie is HIPAA, SOC-2, PIPEDA, GDPR, and PCI-Compliant
- Healthie is hosted on Aptible and AWS
- Each developer maintains their own login credentials, and full audit trails are available
- We will sign a BAA with you
Getting Started with Our API
- Access our API docs here.
- Generate API Keys on Production.
- Generate Webhooks on Production.
- Generate Sandbox API Keys and Webhooks.
How Organizations use Healthie's API
Healthie's Organizations have leveraged Healthie's API to build member experiences, build tooling for providers, and much more. You can use Healthie fully headless leveraging the API, and/or leverage components of Healthie's UI alongside your own build.
You can leverage the API to build in the language of your choice.
We see customers use the API to do everything from:
- Develop custom front-end interface for providers and/or clients leveraging Healthie's back-end functionality (e.g., build out your own member experience leveraging our API / SDKs)
- Access data across the platform to establish custom dashboards and connect with your data warehouse
- Add automations to tie features of Healthie together for your clinical workflows
- Create custom onboarding / intake experiences for prospective clients, leveraging intake flow fields and connections to calendar, for example for provider matchmaking
- Leveraging our existing integrations, or build your own integrations, to weave Healthie into your tech-stack
- Some organizations will use Healthie's API adjacent to the web white-label and mobile white-label to further customize the experience for clients
- and much more
API Best Practices
Here are some best practices / typical use cases for prioritizing a build with Healthie's API
- Build out a member experience mobile app and / or web platform
- Use Healthie's UI for Members, but enhance it by adding iframe to the sidebar (requires web whitelabel)
- Building out an intake flow experience that links from your website
- Connecting Healthie with a data warehouse / BI tool
- Healthie does not currently have the 'Client Packages' feature on our mobile apps including on the mobile white-label; if you want to add Client Packages to your mobile app build, it is possible, though you could be subject to Google / Apple App Store Guidelines around third party purchases and we recommend thinking through your workflows accordingly
QAs and SLAs
As a developer-first technology company, maintaining a high-quality, functional API experience is incredibly important to us. Given that we use the same API that we offer to our customers, there is an inherent level of quality that exists in the API, as it is naturally battle tested.
Healthie maintains an uptime of 99.99% and our Organization Plan includes an SLA.
Sandbox (Staging) environment
We can provision a Sandbox (Staging) environment as part of working with the API. This is distinct from your Production account. Here are some best practices & differences between the two environments:
- Sandbox (Staging):
- This is a great testing environment, where you will have nearly all of the capabilities of Healthie. You can, for example, create fake provider and client accounts, test experiences like onboarding and package creation.
- We do not recommend adding PHI to your staging environment
- Some integrations are not available in your sandbox account (e.g., Zoom, Outlook, iCal syncs)
- Google Calendar can be used on Sandbox, but Healthie has to pre-approve the account prior to your using it.
- Dosespot E-Rx can be tested in Sandbox
- Sandbox is less resourced than Production, so you may see higher latency taking some actions in Sandbox
- Production: Your actual, live Healthie account. You would want to take actions like build out forms and finalize settings in your Production environment.
Sandbox (Staging) and Production are two independent environments, and data / settings cannot transfer from Staging to Production. Learn more about generating API Keys and Webhooks in your Sandbox account here.
In addition to our GraphQL API, we also provide React SDKs to make it easier for developers to work with our API within their existing frontend applications and accelerate the development process.
Our SDKs provide a set of pre-built components and functions that can be integrated into your application, allowing you to access the functionality of Healthie's API with minimal setup and configuration. However, it is important to note that while the SDKs provide a simplified way to interact with our API, the developer is still responsible for providing the scaffolding and overall structure of the application.
It's worth to mention that these SDKs are designed to work with our GraphQL API only, and it is recommended to have a basic understanding of our API before using them.
Currently Healthie provides SDKs for the following capabilities:
- Chat SDK (view on npm)
- Forms SDK (view on npm)