1. Home
  2. Knowledge Base
  3. Supported Hardware
  4. Ubiquiti
  5. Ubiquiti Unifi API Configuration Guide

Ubiquiti Unifi API Configuration Guide

Why upgrade to the new Unifi API Integration?

With the Unifi API Integration your hotspots can fully utilize advanced login features like Guest Plans or Ad-Based login and provide guests the correct rate-limiting settings for the method used.

You can confirm your environment under Operator Customizations.

Checklist before proceeding with the Unifi configuration

  1. Please ensure the necessary ports are open to the controller per Unifi documentation.
  2. The MAC of your Unifi Access Points must be added to a hotspot in the Marketing 4 WiFi 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!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.

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. 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:
      • Guest Landing Page: ON
      • Advanced: Manual
      • Landing Page: Select Promotional URLand use one of the following
      •  Redirection-
        1. Enabled HTTPS Redirection: Unchecked
        2. Enable encrypted redirect URL: Unchecked
        3. Use Secure Portal: Checked
        4. Redirect Using Hostname: Checked
      • Allowed 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.
    4. On the menu to the left click Wireless Networks.
      • Create a new Wireless Network or Edit your existing Guest WiFi network.
      • WiFi Type: Guest Hotspot
      • Press Apply Changes to save.

Platform IP Addresses for Unifi API Integration

The following table shows the IP addresses that the Marketing 4 WiFi platform could make use to make outbound connections to the Unifi controller to authenticate guest sessions.


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

Ubiquiti UniFi CloudKey Version 7.2.92-18687-1 Firmware 1.1.19
Ubiquiti UniFi UAP-AC-Lite

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 18, 2023

Was this article helpful?

Related Articles

Need Support?
Can't find the answer you're looking for? Don't worry we're here to help!