Questly integration guide

How it works

You place a single prominent task in your app: “Complete Questly tasks” with a big reward. This task should always be available to users.
When a user clicks on it, they’ll be directed to our offerwall (questlythebot tailored to your app), where they can complete various tasks to earn your currency.
Once the user completes tasks and earns rewards, they return to your app, and you credit their balance with the earned amount. They can then open the offerwall again and repeat the process.

Watch the video below to see how it works:

https://drive.google.com/file/d/1YzpJQ19DpTWy84Ehu5hkEoBNi-iGid2o/view?usp=sharingdrive.google.com

Step 1: Integrating Questly Task in Your App's Interface

Example of a Questly Task Display in Your App:

Title: Questly Description: Complete Questly tasks and earn rewards Reward: Up to 10.00 daily Button label: Get Reward Icon Questly:

Example of a Questly task interface in the app:

Step 2: Adding the Get Reward Button Link

The Get Reward button must link to the Questly Mini App:

https://t.me/questlythebot/app?startapp={apikey}

Where:

{apikey} — the API key provided by the TappAds team.

Step 3: Opening the Link Using the Telegram Library

To open the link correctly, use the following method from the Telegram library:

Telegram.WebApp.openTelegramLink('https://t.me/questlythebot/app?startapp={apikey}');

Step 4: Claim Reward via GET Method

After the user clicks the Claim button, use the following method to transfer the reward from Questly:

https://wallapi.tappads.io/v1/wall/claim?apikey={apikey}&user_id={user_id}

Where:

{apikey} — the API key provided by the TappAds team.
{user_id} — the user's Telegram ID.

JSON Response Example:

{
    "balance": 1000,  // Reward amount
    "currency": "COIN"  // Publisher’s currency
}

Step 5: Reward Currency Icon

For a more personalized user experience, provide the TappAds team with your app’s icon to be used as the reward currency symbol. This will help users understand that the rewards they earn in Questly can be transferred to your app.

Publisher Checklist:

✅ Integrate the Questly task into your app’s interface. ✅ Add the Get Reward button with the correct link. ✅ Implement the Claim button to transfer rewards. ✅ Provide a link to your app's dev version for the TappAds team to review the integration and assist with testing. ✅ After successful testing, move the integration to your production version. ✅ Ensure users receive rewards after completing tasks and start earning with Questly.

Full Integration Code Example:

<!DOCTYPE html>  
<html lang="en">  
<head>  
    <meta charset="UTF-8">  
    <title>Questly Integration</title>  
    <script>  
        Telegram.WebApp.openTelegramLink('https://t.me/questlythebot/app?startapp={apikey}');  
    </script>  
</head>  
<body>  
    <button onclick="claimReward()">Claim</button>  
    <script>  
        function claimReward() {  
            fetch('https://wallapi.tappads.io/v1/wall/claim?apikey={apikey}&user_id={user_id}')  
                .then(response => response.json())  
                .then(data => console.log('Reward claimed:', data))  
                .catch(error => console.error('Error claiming reward:', error));  
        }  
    </script>  
</body>  
</html>

Support and Contact

If you have any questions regarding the integration process, feel free to contact our support team. We are always ready to assist with setup and testing.

PreviousIntegration instructions NextFeed integration

Last updated 1 year ago

hashtagHow it works

hashtagStep 1: Integrating Questly Task in Your App's Interface

hashtagStep 2: Adding the Get Reward Button Link

hashtagStep 3: Opening the Link Using the Telegram Library

hashtagStep 4: Claim Reward via GET Method

hashtagJSON Response Example:

hashtagStep 5: Reward Currency Icon

hashtagPublisher Checklist:

hashtagFull Integration Code Example:

hashtagSupport and Contact