Skip to content

Integrator guide

Halo Cloud overview Halo Link overview Integrator Portal Security overview Release notes Troubleshooting Contact Support

What is Halo Connect?

Halo Connect is an interoperability platform that provides APIs to integrate third-party applications to Practice Management Systems (PMSs). For on-premise PMSs, Halo Connect removes the need for installing a local agent on each practice's server, and instead enables you to connect to the on-premise server via our APIs.

For integrators, this means:

  • Lower barrier to entry for new integrations, by removing the need to build, maintain, and support your own local agent.
  • Reduced cost of customer support, by leaving the monitoring and maintenance of local agent instances to us. We monitor for outages and performance issues and proactively work with practices to resolve issues. We also offer API endpoints for integrators to check a practice's status, so you can know whether a practice is connected at any point in time.
  • Safe, secure and reliable data transmission, by using a well-behaved agent that protects practice infrastructure and looking after encryption, transmission, and keeping local agents up to date.

Our local agent, Halo Link, is bundled with Bp Premier and Zedmed, so integrating via Halo Cloud means practices only need to enable your integration in the PMS UI for you to be able to start sending queries.

Halo Connect products

Halo Connect has two core products:

  • Halo Cloud: a set of API services which allow integrations to communicate with practice servers which have Halo Link installed.
  • Halo Link: a local agent that is installed on practice servers and enables communication with Halo Cloud.

We also have an Integrator Portal to enable self-service support.

How to find out more?

Supported PMS

Accessing the Halo APIs

Prerequisites

To start developing against the Halo Connect APIs, you need to be an approved Partner of the relevant PMS you wish to integrate with.

Once approved, the PMS Vendor will provide you with a test license or instance for the PMS, and provide us the relevant credentials required for us to generate a Stage subscription for you.

Use of the Halo Connect Stage environment is free for 6 months, after which an annual fee applies.

Staging subscriptions should not be used in production environments

Halo Connect's Staging environment is designed for testing and development. Before using Halo Connect in production at a real practice, you will need to switch to the Production environment.

Staging subscription

When you sign up for a staging subscription, you will receive from Halo Connect:

  • A Halo Connect subscription key.
  • A Halo Link installer.
  • Onboarding instructions for setting up Halo Link on your PMS test instance, retrieving the required identifiers, and forming your initial query to the API.

In addition to the onboarding instructions, we recommend you read additional documentation, including:

Support during development

Our team is here to help you understand how to use the APIs to best meet your various use cases. We are happy to provide technical advice and feedback on any proposed workflows, and help you understand how things work in Production for practice onboarding, troubleshooting, and general use.

We do not inspect your queries or the query results unless you specifically provide them to us to assist with troubleshooting.

Moving to Production

Once your integration is working with Halo Link in staging, please contact us to discuss moving to the Production environment. This will require:

  • Meeting any requirements set by the PMS you are integrating with.
  • Signing a Halo Connect order form to agree to the pricing and terms and conditions.
  • Meeting the security requirements (talk to us for more information).

We also provide targeted support through the production planning and go-live phases, including:

  • A discussion regarding your rollout strategy and review of any onboarding instructions you may have to ensure alignment.
  • Meeting your support team and providing information about how they can liaise with our support team to assist practices when there are issues.
  • Monitoring production tests at trial practices before rolling out to a wider customer base, so both your team and ours can ensure everything is running smoothly.

Next steps

Next: Halo Cloud overview

Version: 25.1028.7355