HyprMX Mediation Integration Guide

This guide will instruct you step-by-step on how to set HyprMX live as an Ad Network on the ironSource Mediation platform.

Before You Start
Make sure you have correctly integrated ironSource’s Rewarded Video or Interstitial into your application. 

Note: The HyprMX SDK currently compiles on iOS 7+ but only serves ads on iOS 9+.

Step 1. Create an HyprMX Account

HyprMX provides a managed service. To create an account with them, contact them directly at integration@hyprmx.com.  Once your account is created, they will help you set up your application and retrieve the required parameters to activate HyprMx in your ironSource account.

Step 2. Activate HyprMX in Your ironSource Network Setup Module

There are 3 pieces of data from the HyprMX account which need to be inserted into your ironSource Network Setup Module in order for HyprMX to work correctly in connection with ironSource:

API Key This is the unique identifier of your account in the HyprMX system.
Distributor ID This is the unique Application identifier which HyprMX will deliver ads to.
Placement ID This is a unique identifier of your Placement with HyprMX.

Once you obtain this information, you must configure HyprMX’s Parameters in your ironSource Account. By adding the above information correctly, you will be able to take full advantage of HyperMX’s ad inventory and reporting data on ironSource’s Mediation platform.

Configure HyperMX’s Parameters into ironSource Account

  • Once you obtain the above parameters, log in to your ironSource account and go to ‘Monetize‘ ➣ ‘Mediation‘ ➣ ‘Network Setup‘.
    ironsource-platform-mediation-network-setup
  • Select HyprMX from the list of available Ad Networks and input the HyprMX  ‘API Key‘. ironsource-platform-api-key-hypermx
  • Next, select the app on which you’d like to run ironSource’s Mediation with HyprMX.
    ironsource-platform-select-app-hyprmx
  • Go to HyprMX on the Setup dashboard and click the Define icon. Then enter the ‘Distributor ID‘  and ‘Placement ID‘ in the relevant fields and click ‘Save‘.
    ironsource-platform-app-settings-hyprmx
  • You will then see HyprMX as Active for Mediation on the Setup Dashboard.
    ironsource-platform-active-mediation-hyprmx
  • New! Verify your integration with the Reporting API; this column will check your integration through the Reporting API and return three possible responses: Verified, Failed and No Response. Double check your integration and the information you entered above; then click ‘Retry‘ until you see ‘Verified’.

Step 3. Add the HyprMX Adapter to Your Build

iOS

 Important! The HyprMX SDK only serves ads on iOS9+.

ironSource supports both Cocoapods and Manual download mechanisms.

Download the HyprMX Adapter with Cocoapods

To integrate the HyprMX SDK with Cocoapods, enter the following line in your podfile and you’re good to go!

pod 'IronSourceHyprMXAdapter','3.2.1.9'

Download the HyperMX Adapter Manually

  1. Download the HyperMX Adapter:
    Add the HyprMX Adapter to your build. You can find the latest HyprMX Adapter here.
    Important! The HyprMX Adapter also contains the HyprMX SDK. You DON’T need to add the HyperMX SDK directly.
  2. Add the HyprMX frameworks to your Project:
    After you download the Adapter, drop the Adapter framework into your Xcode Project, i.e. drop ISHyprMXAdapter.framework into your Xcode project.
  3. Add Required Frameworks:
    Go to TargetsBuild Phases ➣ Link Binary With Libraries.
    ios_frameworks
    Click ‘+’ to add the following frameworks:

    libxml2.2.tbd
    EventKitUI.framework
  4. Add Linker Flags:
    Add two separate linker flags to TargetBuild SettingsLinkingOther Linker Flags:
    Objc
  5. Configure App Transport Security (ATS) SettingsAdd the following keys to your plists:
    <dict>
        <key>NSAllowsArbitraryLoads</key>
        <true/>
        <key>NSAllowsArbitraryLoadsForMedia</key>
        <true/>
        <key>NSAllowsArbitraryLoadsInWebContent</key>
        <true/>
    </dict>

     

 When you submit your application, you will have to provide justification for these ATS settings. HyprMX recommends you note that your ad partners require loading web content from a variety of sources, including those that do not yet support HTTPS. Apple has already agreed that this is acceptable justification in their documentation.

Evaluate Your Ad-Network Integration

  • Verify your ad network integration with our Integration Helper. The ironSource SDK provides a tool to ensure you’ve successfully integrated our SDK as well as any additional network adapters.
  • Manage the debug logs for your integrated mediation ad networks with this boolean
    [IronSource setAdaptersDebug:YES];

    When set to YES, this line of code will enable debug logs to help you troubleshoot issues with all of your mediation ad networks. Remove this code before your app goes live with our ad units! Supported for SDK versions 6.5.2 and up.

Done!

You are now all set to deliver HyprMX within your application!


What’s Next?
To leverage additional ad networks through ironSource Mediation, integrate the adapters and follow our integration guides.