Reference
Status and API
In the dashboardReferenceStatus and API
Two things sit outside the dashboard: the status page that reports whether Halo Cloud is up, and the REST API that the dashboard itself is built on. Both are public and neither needs a dashboard login.
Service status
Section titled “Service status”status.halowifi.com is the status page for Halo Cloud. It is checked every minute and keeps thirty days of history. Four components are tracked: Controllers, Realtime, Website and API Services. Open incidents and scheduled maintenance are listed on the page with their timeline, so it is the first place to look when a dashboard screen stops updating.
The status page is run outside the dashboard and stays reachable when the dashboard is not.
REST API
Section titled “REST API”The HaloWiFi API is documented on halowifi.com/api. It covers fourteen REST endpoints in five groups: authentication, locations, networking, guest login and payments. Requests and responses are JSON. Every path is under /external and stays stable.
Authentication is a Bearer token. Exchange a key and secret for the token at POST /external/token; the token is shown once, and the pair can be rotated at any time from the account. Rate limits are printed on every response header. Every account also gets a sandbox venue with fake guests that produce real-shaped data, so integrations can be tested without touching a live location.
The API is in private beta. Access is free; the base URL and keys arrive together when an account is enabled.
Signing in
Section titled “Signing in”The dashboard itself is at cloud.halowifi.com. Every page in these docs describes one section of it.