Integrator Portal
The Integrator Portal is a web portal designed to help integrators self-serve various support needs. This page outlines its features and how to sign up.
Features
The Integrator Portal has both administrator and support-focused features.
Support features
- View your current integrator configuration including quotas, rate limits, and webhooks
- View your webhook statistics and see recent webhook failures (if configured)
- Check the connectivity status of Halo Link at a practice (functionality is equivalent to the Get site status endpoint)
- Send a test query to a practice (the query is pre-written and not editable)
Note: Because test queries do actually query the practice from your account, they will count towards your usage for that practice for that month.
Admin features
- Rotate your primary and/or secondary API key
Future features may include further support actions, analytics views, and admin operations. To request features please contact Support.
User accounts
User accounts are managed by Halo Connect, and it is currently a manual process.
To register users for the Integrator Portal for a given company, please get an administrator to contact Support to nominate users.
All users must configure Two Factor Authentication for their account on first login.
Removing users is also managed by Halo Connect. Please get an administrator to contact Support to remove users.