Ubiquiti Unifi API Configuration

Checklist before proceeding with the Unifi configuration

  1. The MAC of all APs that will be broadcasting the Guest WiFi signal as well as the Unifi Controller portal URL with a valid username and password for an administrator must be reported to support.
  2. Due to the various user interfaces Unifi has supported throughout the history of their products and versions, you will need to select the correct section below that matches your user interface to complete the configuration process.


The following instructions outline how to setup a Ubiquiti UniFi network for the Smart WiFI 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.

Configuration Guide One

  1. Login to your Unifi controller and select the correct site
  2. On the menu to the left, click the Settings option
  3. On the WiFi Tab, click Create New or Edit your existing Guest WiFi
    • Hotspot Portal: Checked
    • Set all other options to best practices
    • Press Add WiFi Network (or Apply Changes)
  4. On the menu to the left, click the Hotspot Manager option
  5. Click the Landing Page tab at the top of the page
  6. Using the menu panel to the right, on the Branding tab configure with
    • Success Landing Page: Select Custom URL and use the value you are provided
  7. Using the menu panel to the right, on the Authentication tab configure with
    • External Portal Server: Enabled
    • External Portal: 8.8.8.8
  8. Using the menu panel to the right, on the Settings tab configure with
    • Show Landing Page: Checked
    • HTTPS Redirection Support: Unchecked
    • Encrypted URL: Checked
    • Secure Portal: Checked
    • Domain: You will be provided this value
    • Pre-Authorization Allowances: Add the value you used for the Domain as well the platfrom Default walled garden entries.
  9. Press Save

Configuration Guide Two

  1. Launch the correct site in your Unifi controller and click the settings icon in the bottom left.
  2. On the menu to the left click Profiles.
  3. Click on the Default option under the Guest Hotspot section and configure with the following settings:
    • Authentication Type: External Portal Server
    • External Portal: 8.8.8.8
    • Guest Landing Page: ON
    • Advanced: Manual
    • Landing Page: Select Promotional URL and use the value you are provided.
    • Redirection-
      1. Enabled HTTPS Redirection: Unchecked
      2. Enable encrypted redirect URL: Unchecked
      3. Use Secure Portal: Checked
      4. Redirect Using Hostname: Checked
        • You will be provided this value.
      5. Allowed Authorization Access: Add all the Default walled garden entries.
  4. On the menu to the left click Wireless Networks.
  5. Create a new Wireless Network or Edit your existing Guest WiFi network.
      • WiFi Type: Guest Hotspot
      • Set all other options to best practices
      • Press Apply Changes to save.

Troubleshooting Splash page

  1. If devices present an certificate error please ensure https redirection is disabled.
  2. If a hotspot deactivated message is presented please ensure all the AP MACs have been added as gateways to the correct hotspot.
  3. 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.

Disclaimer on hardware configuration guides in the KB:

This equipment has been integrated and tested in our labs with the Marketing4WiFi platform using the firmware versions below.

  • UniFi CloudKey Version 7.2.92-18687-1 Firmware 1.1.19
  • Unifi UDM SE OS Version 3.2.12
  • Unifi Network Server Network 8.1.113
  • Unifi U6 Lite Version 6.6.55

LIMITED HARDWARE SUPPORT: Hardware manufacturers frequently make changes to firmware, controllers and GUI’s. The information below may be out of date or images may be different and is to be used as a general reference guide. We do offer additional limited support to help with trouble-shooting and we highly recommend that you have a hardware support agreement and/or access to a hardware support engineering representative from the manufacturer.

Updated on April 10, 2024

Was this article helpful?

Related Articles