Skip to content
ReadyZone Docs
API Reference

Portal API Reference

Endpoints consumed by ReadyZone captive portals.

Base addresses

Available endpoints

Template variables

Portal templates use the following values during generation:

  • {{apiBaseUrl}}: Core API base URL used to build /api/... requests.
  • {{companyReference}}: public zone reference used in API paths and parameters.
  • {{cloudBaseUrl}}: ReadyZone Cloud base URL used, among other things, to build /checkout/{planId} links.

The portal can also receive these values through window.HOTSPOT_RUNTIME_CONFIG, window.COMPANY_API_BASE, window.COMPANY_REF, and window.CLOUD_URL. Runtime values take precedence over values injected during generation.

Payment rules

The portal must follow the purchase button display rules.

On this page