Ubiquiti Unifi API Configuration

The following instructions outline how to setup a Ubiquiti UniFi network for the Marketing4WiFi Platform utilizing the API integration. This guide assumes that your Unifi controller is already operational and on a live network with adopted Access Points. Please make sure any firewall rules, web content filters, and other security measures have been configured to interface with the platform.

1. 1. Add your Ubiquiti Unifi Access Points to the Marketing4WiFi Dashboard using the Ubiquiti Unifi API gateway type. You will need to enter a portal URL where the controller can be reached as well as a valid Administrator Username and Password before pressing ‘Test API Credentials’ to generate a list of possible sites to select from. Be sure to Submit the page!
      
      Unifi Connection Terminate

      Enabling the Unifi Connection Terminate toggle will result in the platform polling the Unifi controller every 15 minutes and de-authorizing any active session if the device MAC is no longer associated to the wireless network with a reason for termination as Lost Carrier.

   2. Log into the controller.
   3. Launch the correct site and click the settings icon in the bottom left.
   4. On the menu to the left click Guest Control and configure with
      • Enable Guest Portal: Checked
      • Authentication: Hotspot
      • Promotional URL: Select one
        US-A Redirect URL

        https://splash.4wifi.net/hotspotlogin.php?res=success

        You can confirm your platform environment under Operator Customizations.
        

        If you have your own branded splash hostname you would use https://splash.yourdomain.com/hotspotlogin.php?res=success

        US-B Redirect URL

        https://splash.4wifi-e2.net/hotspotlogin.php?res=success

        You can confirm your platform environment under Operator Customizations.
        

        If you have your own branded splash hostname you would use https://splash.yourdomain.com/hotspotlogin.php?res=success

      •  Redirection-
        1. Use Secure Portal: Unchecked
        2. Redirect Using Hostname: Unchecked
        3. Enabled HTTPS Redirection: Unchecked
        4. Enable encrypted redirect URL: Unchecked
      • Template Engine: Angular JS
      • Override Default Templates: Checked
      • Pre-Authorization Access: Add all the Default walled garden entries.
        

        If you’re a white label client and you have your own splash domain, be sure to include it in the walled garden.

      • Press ‘Apply Changes’ to save.
   5. On the menu to the left click Wireless Networks.
      • Create a new Wireless Network or Edit your existing Guest WiFi network.
      • Check the Guest Policy box to enable the Guest Control settings.
   6. Final Step- Place the two HTML files from your dashboard’s Ubiquiti Unifi API gateway page onto your Unifi controller hotspot directory for the site code used in step one.
      

      If your splash hostname changes you must update these two files as well as your pre authorization access list.

      Typical file location examples are below.(depending on the UniFi controller):
      Please note you will typically use your site auto generated folder name instead of default.
      Dream Machine: /data/unifi/data/sites/default/app-unifi-hotspot-portal
      CloudKey: /srv/unifi/data/sites/default/app-unifi-hotspot-portal
      Windows: C:\Users\<username>\Ubiquiti UniFi\data\sites\default\app-unifi-hotspot-portal
      MAC: ~/Library/Application Support/UniFi/data/sites/default/app-unifi-hotspot-portal
      Linux: /usr/lib/unifi/sites/data/default/app-unifi-hotspot-portal
      

Troubleshooting Splash page

1. If devices are redirected but the device hangs on the controller url please ensure port 8880 is open to the Unifi Controller.
2. If devices are redirected and port 8880 is open to the controller please ensure that the ‘Secure Portal’ option is turned OFF.
3. If devices present an certificate error please ensure https redirection is disabled.
4. If a hotspot deactivated message is presented please ensure all the AP MACs have been added as gateways to the correct hotspot.
5. If devices are redirected to the splash page URL but the page fails to load please ensure the Allowed Authorization Access list has been properly configured.
6. If the internal captive portal from the Unifi controller is displayed instead of the hotspot splash page make sure ‘Override Default Templates’ is ON and the index and auth files have been placed on the correct site directory.