Improving Radar Healthcare’s customers experience
An API Serving Healthcare
At a time when healthcare is more critical than ever, Radar Healthcare has positioned itself since 2012 to empower healthcare professionals to rely on tools for managing risks, quality, and compliance in healthcare environments to ensure patient well-being and safety.
Their clients, ranging from hospitals to government organizations, use software with numerous modules such as incident management, action and improvement plans, analytics, and workforce compliance.
Some of these modules are also available through Radar Healthcare’s API, a Partner-Exclusive API offering more flexibility and better integration into their clients' existing environments. However, without initial API documentation, the Radar Healthcare team had to invest heavily in answering API-related questions, providing demonstrations, and troubleshooting for their clients.
Adoption and Integration
Quickly, the importance of having comprehensive documentation became evident to help their customers fully benefit from the potential of the API for their organizations:
"We wanted to document our API as we understood the benefits of this, so we extensively researched a range of API documentation tools and compared them all according to a number of criteria that were very important to us, such as user experience, development effort required to set things up, support, data security compliance, branding, and customization. Bump.sh was the tool that matched our criteria."
The integration of Bump.sh into the tech stack and workflow was a smooth process. Radar Healthcare already had an OpenAPI specification file, and the many resources available (guides, help center) as well as the quick support helped them get started quickly, establishing a solid foundation within a few days to build upon.
The team quickly adopted several features that help them daily in maintaining their API documentation, such as custom code samples (supporting any languages beyond cURL) and external file rendering (from Markdown files), especially the option to add contextual information and images beyond the simple endpoint documentation.
"We love being able to deploy updates to our new documentation swiftly in whichever way is easiest for us, either via the command line integration or via the admin portal. It saves us a lot of time to have code samples displayed automatically in many different programming languages. And it's useful for us to create content (words and images) and publish them alongside the endpoint documentation. We have created topics to cover things as crucial as use cases for our API, authentication, or troubleshooting."
Radar Healthcare's Customer Feedback
By offering Radar Healthcare a set of features and resources, Bump.sh has enabled them to provide rich and easily accessible documentation to all their users. When users contact them with questions, the team can easily share a link pointing directly to the relevant part of the documentation.
A few months after implementing this new API documentation, Radar Healthcare conducted a survey among its clients to measure the impact of the documentation and Bump.sh on their experience.
"Compared to other APIs we work with, the level of documentation is so much better. For other APIs sometimes you just get a Swagger doc with no content added beyond the specification."
"Really helpful to have parameters and filters that are available for a given endpoint, as it's not always obvious and often not documented."
Internally, Radar Healthcare has seen significant time and resource savings across various teams: developers appreciate the flexibility of code samples, and technical writers can more easily manage deployments thanks to the various available methods.
"Using Bump.sh has allowed us to have neat, easy-to-digest API documentation that we can update as needed and tailor to our users' needs. There is a lot that Bump.sh does by default, which saves us a lot of time, and a lot that we get to do easily because of how Bump is built."