WiFi advertising API

Wimedia WiFi Advertising API: Transform Your WiFi into a Revenue Stream

Turn your existing WiFi network into a source of additional income while providing a seamless user experience. Our API integrates targeted advertising directly into your captive portal.

How the Wimedia WiFi Advertising API Works

  1. User Connects to Your WiFi: A user attempts to access your WiFi network.
  2. Captive Portal Integration: Your captive portal system intercepts the connection request and obtains the user's device MAC address.
  3. API Request: You construct a Wimedia service URL with the following parameters:
    • YOUR_API_KEY
    • YOUR_PLACE_ID
    • USER_MAC_ADDRESS
    • (Optional) YOUR_CALLBACK_URL
    • (Optional) LOGIN_URL
  4. User Redirected: The user is temporarily redirected to the Wimedia service.
  5. Intelligent Ad Selection: Wimedia gathers basic, non-personally identifiable data (approximate location, general interests) from the MAC address and utilizes machine learning algorithms to select the most relevant ad for that user.
  6. Captive Portal Ad Display: The selected ad is displayed to the user within your captive portal environment.
  7. User Interaction:
    • Click or Skip: Whether the user clicks the ad or skips it, they are redirected to either:
      • Callback URL: Returned to your captive portal, where you control their journey.
      • Login URL: Wimedia sends generic login credentials (e.g., "ad"/"ad") to your login URL via a POST request, granting the user temporary internet access.
    • If Clicked: If the user clicked the ad, they are additionally redirected to the advertiser's website after the Callback or Login action.

Key Benefits for Telecoms & Venues

  • New Revenue Stream: Effortlessly monetize your existing WiFi infrastructure.
  • Enhanced User Experience: Display relevant, non-intrusive ads instead of disruptive interruptions.
  • Valuable Insights: Gain basic demographic and interest data about your WiFi users.
  • Easy Integration: Our API is designed for simple implementation within your existing WiFi system.
  • Full Control: You maintain complete control over the types of advertisements displayed on your network.

Detailed Integration Guide

  1. Obtain Your API Key & Register Places: Contact us at info@wimedia.am to receive a unique API key and register your venues or locations. Each location will receive a unique PLACE_ID for use with the API.
  2. Add Domain to Walled Garden: Add the Wimedia service URL domain to your walled garden list to allow unauthorized users to access this domain for ad display purposes.
  3. API Request Construction:

    http://wimedia.am/service/hotspot/showad?key=YOUR_API_KEY&place_id=YOUR_PLACE_ID&mac_address=USER_MAC_ADDRESS&redirect_url=YOUR_CALLBACK_URL

    * Parameters:
    • YOUR_API_KEY: The unique key assigned to your organization.
    • YOUR_PLACE_ID: The unique identifier for your venue or location.
    • USER_MAC_ADDRESS: The MAC address of the connected user's device (obtained by your captive portal).
    • YOUR_CALLBACK_URL (Optional): The URL to redirect the user back to after ad interaction for continuation within your captive portal.
  4. Redirection & Login Handling:
    • Callback URL Implementation: If you provide a `YOUR_CALLBACK_URL`, Wimedia will redirect the user back to this URL after ad interaction. A `final_destination` parameter will be appended, indicating either the user's originally requested URL or the advertiser's landing page if they clicked the ad.
    • Automatic Login: If you provide a `LOGIN_URL`, Wimedia will send a POST request to this URL containing generic credentials (e.g., username: "ad", password: "ad") to automatically grant the user internet access, temporarily bypassing your regular login process.

Important Considerations

  • User Privacy: Wimedia prioritizes user privacy. The collected data is non-personally identifiable and used solely for ad targeting purposes.
  • Ad Quality: We uphold strict standards for advertisements displayed through our API to ensure a positive user experience on your network.
  • Customization: For venues with specialized captive portal requirements, we offer custom API solutions to ensure seamless integration.

Start Earning Revenue from Your WiFi Today

Contact us at info@wimedia.am to explore how the Wimedia WiFi Advertising API can benefit your business.