AdLychee Documentation

Introduction

Welcome to AdLychee's documentation page.

Getting Started

An Account is required to continue with App setup and configuration. Once you have created an account you will have full access to our platform.

Create an account:

  1. Navigate to AdLychee Registration Page
  2. Fill up the Registration form and click on Sign Up.
  3. After that you can login to your members area.

Creating an App

An application is required to use any of our tools, after that you will need to integrate our offerwall to your app.

Create an app:

  1. Login to AdLychee Account
  2. In Menu, click on Apps -> Add new app.
  3. Complete all the form fields and click on 'Create'.

Public key

An Public key is required to our offerwall to your users or to retrieve our offers.

Get AppId & Secret Key:

  1. Login to AdLychee Account
  2. In Menu, click on Apps -> Choose an App -> HTML Code.
  3. Copy the Direct link or Iframe tag and replce {uid} to user id

Editing an App

  1. Login to AdLychee Account
  2. In Menu, click on Apps -> Choose an App -> Edit -> Update Information.
  3. Complete all the form fields and click on 'Update'.

Delete an App

  1. Login to AdLychee Account
  2. In Menu, click on Apps -> Choose an App -> Edit -> Update Information.
  3. click on 'DELETE' and Confirm to delete app.

Test Postabck

  1. Login to AdLychee Account
  2. In Menu, click on Apps -> Choose an App -> Edit -> Test Postback.
  3. Complete all the form fields and click on 'Submit' To send Postback.

OfferWall Integration

Integrating our OfferWall can be done in any one of the following methods.

Important!

All of the below methods expect you to pass a valid appId/PublicKey to show appropriate offerwall and a userId from your App or Website.

Direct Link

https://www.adlychee.com/offers?appId=[PUBLIC_KEY_HERE]&uid=[USER_ID_HERE]

Iframe Tag

<iframe src="https://www.adlychee.com/offers?appId=[PUBLIC_KEY_HERE]&uid=[USER_ID_HERE]" style="width:100%; height:2400px; border:none;" frameborder="0"></iframe>

Postback Parameters List

Parameter Value
{userID} Unique user ID passed via the offerwall URL.
{reward} Reward amount, in your defined reward.
{offerName} Name of the offer.
{revenue} The revenue, in USD, you earned from this conversion.

Postback Example Script

adlychee.php :


<?php
/*
 * @AdLychee
 *
 * Postback Example Script.  This script is meant to only be a rough outline of
 * how a postback should operate, and not necessarily used out of the box.
 * 
 * Copyright 2024. AdLychee. All Rights Reserved
 */

// Setup postback variables.  
$user_id = $_GET['user_id']
$offer_name = $_GET['offer_name'];
$reward = $_GET['reward'];
if(isset($user_id) && isset($offer_name) && isset($reward)){
    // reward user here
    // Postback Received
    echo 'OK';
}else{
    
    // Postback Not Received
    echo 'NOT OK';
       
}
    

?>

Postback URL Example

https://www.your-site.com/postback/adlychee.php?user_id={userID}&offer_name={offerName}&reward={reward}