Brand Logo Brand Logo
Brand Logo
  2. Dashboard
  3. API Documentations

API Documentation

Access our comprehensive API documentation to integrate HaloWiFi features into your applications.

Welcome to the HaloWiFi API documentation. Our RESTful APIs provide programmatic access to manage locations, networks, guest access, and other core platform features. Use these APIs to integrate HaloWiFi capabilities into your applications and automate your WiFi management workflows.

Available API Endpoints
Endpoint Description Method Details
/external/token Generate authentication token POST View Details
/external/locations Get all locations GET View Details
/external/locations/{id} Get specific location details GET View Details
/external/guest-login-apps Retrieve login applications POST View Details
/external/location/{id} Get location information by ID GET View Details
/external/locations/add Add a new location POST View Details
/external/location/{id}/networking Update or create networking for a location POST View Details
/external/location/{id}/networking/{uuid}/update Update specific networking settings POST View Details
/external/wifi-login External WiFi Login POST View Details
/external/location/{id}/networking-devices/add Add a new router to a location POST View Details
/external/location/{id}/networking-device/{uuid} Update networking device for a location PUT View Details
/external/location/{id}/branding Update branding for a location POST View Details

These endpoints provide core functionality for integrating with the HaloWiFi platform. Each endpoint requires proper authentication using your API credentials. Rate limits and usage quotas apply.

Integration Guides
Guest Login APP Integration

Learn how to integrate the Guest Login APP into your application for seamless guest WiFi access management.

View Guide
Manage Locations

Discover how to programmatically manage multiple locations, including creation, updates, and location-specific settings.

View Guide
Network Management

Learn how to configure and manage network settings, including SSIDs, security policies, and bandwidth controls.

View Guide

For any support or questions about our API, please contact us at hello@halowifi.com