HyprMX Mediation Integration Guide for SDK 6.4 and Below

This guide will instruct you step-by-step on how to set HyprMX live as an Ad Network on the ironSource Mediation platform. The integration process is completed in a few simple steps:

  1. Create an Account & Application in HyprMX
  2. Activate HyprMX in Your ironSource Network Setup Module
  3. Add the HyprMX Adapter to Your Build 
  4. Update AndroidManifest.xml

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 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

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/supersonic/android-adapters"
    }
    }
  2. Add the Adapter’s Maven name to your build.gradle script of your app module.
    dependencies {
    compile 'com.supersonic.adapters:hyprmxadapter:2.1.3@jar'
    }

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.
    Supersonic HyperMX Drop Libs
  3. In Android Studio go to FileNew New Module ➣ Import .JAR.
    Navigate to the location where the HyperMX SDK has been downloaded.
    Supersonic Add New Module in Android Studio

Step 4. Update AndroidManifest.xml

Manifest Permissions:
Add the following permissions outside the <application> tag:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>


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

<activity
  android:name="com.supersonic.adapters.hyprmx.MediationHMXActivity"      android:configChanges="orientation|screenSize|keyboardHidden|keyboard|smallestScreenSize|uiMode|fontScale|screenLayout|locale">
        </activity>
        <activity            android:name="com.hyprmx.android.sdk.activity.HyprMXOfferViewerActivity"
android:configChanges="keyboardHidden|orientation|screenSize"
android:label="HyprMX SDK"
android:launchMode="singleTop" />
<activity          android:name="com.hyprmx.android.sdk.activity.HyprMXRequiredInformationActivity"
android:configChanges="keyboardHidden|orientation|screenSize"/>
        <activity            android:name="com.hyprmx.android.sdk.activity.HyprMXNoOffersActivity"
android:configChanges="keyboardHidden|orientation|screenSize" />
        <activity            android:name="com.hyprmx.android.sdk.activity.HyprMXWebTrafficActivity"
android:configChanges="keyboardHidden|orientation|screenSize" />
        <activity
            android:name="com.hyprmx.android.sdk.activity.HyprMXVideoPlayerActivity"
            android:configChanges="orientation|keyboardHidden|screenSize" />

Verify Your Ad-Network Integration

The ironSource SDK provides an easy way to verify that your Rewarded Video Mediation integration was completed successfully. To verify your ironSource and additional Ad Networks integration, follow this document.

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


What’s Next?
To add additional Rewarded Video Ad networks, follow the integration guides on our Supported Ad Networks list.