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. 

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 HyprMX’s ad inventory and reporting data on ironSource’s Mediation platform.

Configure HyprMX’s Parameters into ironSource Account

  • Once you obtain the above parameters, log in to your ironSource account and go to ‘Monetize‘ ➣ ‘Mediation‘ ➣ ‘SDK Networks‘.
  • 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.
  • Go to HyprMX on the Setup dashboard and click the Define icon. Then enter the ‘Distributor ID‘  and ‘Placement ID‘ in the relevant fields. If you’d like to activate this network in specific countries, you can select these from the dropdown. Click ‘Save‘.
  • You will then see HyprMX as Active for Mediation on the Setup Dashboard.
  • 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

Unity Plugin (Android Integration)

  1. Download the HyprMX Unity Package:
    Import the  IronSourceHyprMXAdapter_[version].unitypackage to your Unity project. You can find the latest HyprMX Unity Package here.
  2. Add the HyprMX files to your Unity project:
    To add the adapter, simply double click on the  IronSourceHyprMXAdapter_[version].unitypackage and add all files to your Unity project.
    Note: If you are upgrading from a previous version, please remove HyprMX.x.x.x.jar from Assets/Plugins/Android.
  3. Make sure you have the support-annotations and support-v4.jar integrated in your project under the Assets/Plugins/Android directory.


Disclaimer: Plugin version 6.7.1

To accommodate changes in Unity version 5.5, the ironSource Plugin version 6.7.1 requires Android Manifests to be added separately to the Plugin and mediation adapter. If you are updating your plugin or currently running on 6.7.1, make sure to add the manifest activities noted in the Android documentation.

  1. For Proguard Users Only
    If you are using ProGuard with the HyprMX adapter, you must add the following code to your ProGuard file (Android Studio: proguard-rules.pro or Eclipse: proguard-project.txt):

    -keepattributes InnerClasses
    -keepattributes Signature
    -keepattributes Annotation
    -keepattributes EnclosingMethod
    -keep class com.hyprmx.** {*;}
    -keep class okhttp3.hyprmx.**
    { *; }
    -keep interface okhttp3.hyprmx.** { *; }
    -keep class com.google.gson.hyprmx.**
    { *; }
    -keepclassmembers class *
    { @android.webkit.JavascriptInterface <methods>; }
    -dontwarn okhttp3.hyprmx.**
    -dontwarn okio.hyprmx.**
    -dontwarn com.google.android.gms.ads.identifier.**

Unity Plugin (iOS Integration)

  1. Download the HyprMX Unity Package:
    Import the IronSourceHyprMXAdapter_[version].unitypackage to your Unity project. You can find the latest HyprMX Unity Package here.
  2. Add the HyprMX files to your Unity project:
    To add the adapter, simply double click on the  IronSourceHyprMXAdapter_[version].unitypackage and add all files to your Unity project.
    Note: If you are upgrading from a previous version, please remove HyprMX.x.x.x.framework from Assets/Plugins/iOS.
    Our Unity Plugin adds the necessary frameworks automatically to your Xcode project.

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

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


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.