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‘.
    ironsource-sdk-network-setup-hyprmx
  • 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. If you’d like to activate this network in specific countries, you can select these from the dropdown. 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

Android

ironSource supports both Gradle dependencies and manual download mechanisms.

Gradle:

  1. Make sure the following Maven URL exist in your build.gradle script of your app module (should appear only once for all the adapters).
    repositories {
    maven {
    url "https://dl.bintray.com/ironsource-mobile/android-adapters"
    }
    }
  2. Add the adapter’s Maven name to your build.gradle script of your app module and add support-annotations and support-v4.jar.
    dependencies {
        compile 'com.ironsource.adapters:hyprmxadapter:4.0.0@jar'
        compile 'com.android.support:support-v4:25.1.0'
        compile 'com.android.support:support-annotations:25.1.0'
    }

Manual download

  1. Download the HyprMX Adapter:
    Add the HyprMX Adapter to your build. You can find the latest HyprMX Adapter here.
  2. Add the HyprMX Adapter to your Project:
    After you download the Adapter; drop the HyprMXAdapter jar into the libs folder in your Android Project. Make sure you have the support-annotations and support-v4.jarintegrated in your project in your libs folder.
    Supersonic HyperMX Drop Libs
  3. Make sure you add the following to your Gradle build file under the dependencies section:

    compile files('libs/hyprmxadapter:4.0.0@jar')
  4. In Android Studio go to FileNew New Module ➣ Import .JAR.
    Navigate to the location where the HyprMX SDK has been downloaded.
    Supersonic Add New Module in Android StudioFor 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.**
    

Step 4. Update AndroidManifest.xml

Manifest activities:
Add the following activities inside the <application> tag on your manifestAdditions:

<activity
    android:name="com.hyprmx.android.sdk.activity.HyprMXOfferViewerActivity"
    android:hardwareAccelerated="true"
    android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize"
    android:label="HyprMX SDK"
    android:launchMode="singleTop"
    android:theme="@android:style/Theme.NoTitleBar.Fullscreen"/>
<activity
    android:name="com.hyprmx.android.sdk.activity.HyprMXRequiredInformationActivity"
    android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize"
    android:theme="@android:style/Theme.NoTitleBar.Fullscreen"/>
<activity
    android:name="com.hyprmx.android.sdk.activity.HyprMXNoOffersActivity"
    android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize"
    android:theme="@android:style/Theme.NoTitleBar.Fullscreen"/>
<activity
    android:name="com.hyprmx.android.sdk.videoplayer.HyprMXVideoPlayerActivity"
    android:hardwareAccelerated="true"
    android:configChanges="keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize"
    android:theme="@android:style/Theme.NoTitleBar.Fullscreen"/>
<activity
 android:name="com.ironsource.adapters.hyprmx.MediationHMXActivity"           
android:configChanges="orientation|screenSize|keyboardHidden|keyboard|smallestScreenSize|uiMode|fontScale|screenLayout|locale">
</activity>

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.