Integrating via REST API

Step 1 Step 2 Step 3 Step 3A Step 3B Step 4

Enabling the Offer Wall

As with most of our products, you first need to configure the Dashboard before you can start coding.

If you have followed all the steps in Adding Your App, you will have already configured the Offer Wall. If so, you may proceed to Step 2: Activating the REST API. 

Note

Before you can configure the Offer Wall, you must make sure that you have your virtual currency configured. If you have not already done so, you can modify your App Settings.

  1. Go to the Dashboard and click through to your selected App.
  2. Go to Placements and click on the Offer Wall tab within your App.
  3. Select placement and make sure Status is set to Active.
  4. Select the currency you wish to use for rewards from the Virtual currency dropdown menu.
  5. Fill in the Exchange rate field with the number of your virtual currency that equates to one Euro or Dollar (depending on the currency you have set in your account settings).
  6. Select the Round up low rewards to 1 unit of virtual currency (recommended) if you would like to show offers that reward less than 1 of your virtual currency. In such cases, its reward rounded up to 1.
  7. Click Save to save your configuration.

    Screen_Shot_2022-05-16_at_13.43.15.png

Remember that you can always add extra virtual currency if you need by clicking on the Settings icon:

The next step is to activate the REST API.

Best Practice Check

To ensure the security of your reward callbacks, we recommend that you calculate the sid parameter and compare it to the parameter sent in the callback. This allows you to verify that the callback came from us.

Configure Your Endpoint in the Fyber Dashboard

Once you have configured your endpoint, you can configure that endpoint in the Callback URL under Reward Handling in Settings tab of the Fyber Dashboard.

Fyber automatically adds in the parameters necessary for you to deliver the reward, so you'll only need to configure the endpoint itself.

7fc6c35-callback__1_.png

Adding the Transaction ID

It is possible to uniquely identify every callback sent to your system with Fyber's Transaction ID.

Checking the Transaction ID is a simple way to ensure that you never incorrectly reward a user twice. We recommend storing all transaction ids on your system and comparing your known list to the id sent in each reward callback.

Security token is generated for you to use when calculating the sid parameter. You may choose to change this token at any time.

Alert!

The Security token you find in the dashboard should never be placed in your client-side integration. This token that should be kept secret between your servers and ours. Ensure that there is no possible way that any of your users can access it.

If you feel your token may have been compromised, you may change it in the dashboard and then update your server-side configurations with the new token.

You can add this parameter by including ?_trans_id_= at the end of your Callback URL in the dashboard. If you already have some parameters as part of your URL, you can include the transaction id instead by including ?parameter=value&_trans_id_=.

Best Practice Check

Due to the universally unique nature of the Transaction ID, adding the ID to your callback ensures that the sid parameter is also universally unique. Using these parameters together, you can add in additional security to make sure that users can not fraud your system into providing unearned rewards.

You have successfully set up Offer Wall via REST API.

Back to Top ⇧