# Tasks, Rewards & API Integration

When advertising your product or project with GAMEE, you will work closely with GAMEE's Head of Partnerships to help achieve your KPI goals and smoothly onboard your company's project tasks into our Telegram application. 

Advertisers can benefit from incorporating an almost limitless number of task types into the GAMEE application, which are designed to encourage user engagement with carefully selected rewards. 

[Click here](https://wiki.gamee.com/partner-with-gamee) to read more about partnering with GAMEE.

## The GAMEE Application

<figure><img src="https://2958752009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MO2G2x2wM_1hfAYzSqY%2Fuploads%2FLojfYpBw1Nqmvnfx6EyS%2FScreenshot%202025-02-07%20at%2011.28.03.png?alt=media&#x26;token=c57a7c09-ca8e-492f-b47a-7202137725a7" alt="" width="563"><figcaption><p>The user experience: how your tasks may appear in the application</p></figcaption></figure>

Tasks that you select will appear in the "Tasks to Do" list in the [GAMEE app](https://t.me/gamee/earn), and can be further promoted with accompanying copy and images in our community channels.

In this section of the app, users come to engage with tasks from GAMEE and our partners in order to discover interesting projects and to receive rewards for their engagement.&#x20;

In addition, tasks may be further boosted by being sent directly to users in GAMEE's communication channels.

## Types of Tasks

There are effectively no limit for tasks that you can choose; as long as the task completion is trackable and is in line with your KPI goals, it can be implemented. You may also opt to feature more than one task in the GAMEE application.\
\
Note that more challenging or time-consuming tasks for users are typically rewarded with more rewards in our app, to further encourage completion.

**Typical tasks include (but are not limited to):**

* Join a partner community
* Play a partner game
* Achieve a specified outcome in a partner app (points, winning a series of games, etc.)
* Create an account on a partner website or application
* Deposit a specified amount in a partner website or application
* Follow social media channels
* Refer a specified number of other users &#x20;

## User Rewards:

At GAMEE's end, rewards are sent when we receive confirmation via the API that the user has completed the required action or actions. The user receives an automated notification via the [GAMEE bot](https://t.me/gamee) that their reward is waiting, and they can then claim it.&#x20;

Rewards we offer depend on what events and products are currently featured in the app, and will be selected by our development team to attain maximum engagement.&#x20;

At different times throughout the year, certain in-app soft currencies are more beneficial to users and that is reflected in the rewards we offer. For instance, they may be:

* **Tickets** – Tickets can be used in the GAMEE application to enter draws with monetary prize pools, boost mining rates, and attain other improvements and advantages to the user experience.
* **Blue Coins** – Similar to Tickets, Blue Coins can be used to improve aspects of the user experience.
* **Spins** – When a cash Wheel of Fortune is active, spins allow the users to spin the wheel with the chance of winning monetary rewards, alongside other soft currencies.

From the partner's side, any additional rewards you may opt to provide can be beneficial, but they are not a requirement. You may offer bonuses, whitelist access or other rewards when a user completes your task, in addition to the rewards that GAMEE provides.&#x20;

## Implementing the GAMEE API

In order to track completed user actions, you will need to integrate the **GAMEE API** and link it to your task action, which his how we track task completion and rewards. The link to this will be provided to you during the discussion phase.

### The Task Flow

The flow takes place over three stages:&#x20;

**1.** The user is able to see the task in the application's **task list**. \
The task shows:

* Small thumbnail image
* Task title
* Task description
* Reward for completion

**2.** When a user clicks on the task, they are directed to an URL of your choosing. In the URL parameters, we pass the user's **Telegram user ID.** After that, it is down to the partner company to save this information and track user progress.&#x20;

**3.** When a user completes the task, the partner will call our API, the task will be marked as completed, and then the reward will be delivered to the user.&#x20;

### Technical Implementation

You will be sent unique GAMEE API parameters during your discussions with GAMEE, and can then use the following guides to help you integrate the GAMEE API into your product:

* [Instructions for implementing API](https://tappadsdocs.gitbook.io/tappads/publishers/integration-instructions)
* [FAQ on implementing API](https://tappadsdocs.gitbook.io/tappads/publishers/faq-for-automatic-integration)

**Each task has 7 parameters:**

| Parameter                 | Example                                       | Details                                                                               |
| ------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------- |
| Task ID                   | 201                                           | Every Telegram task has its own unique ID number                                      |
| Icon                      | *A brand logo*                                |                                                                                       |
| Name                      | *Follow MrCrypto on X!*                       | Call to action for the task                                                           |
| Description               | *Join the crypto revolution!*                 | Additional details                                                                    |
| URL with specified UserID | *<https://example.com/?uid={telegramUserId}>* | Telegram UserID will be replaced by actual UserID.                                    |
| Authentication token      | mrcrypto                                      | The authentication token is partner-specific and must be passed in the request header |
| Reward                    | *1000 Tickets*                                | Reward user gets upon task completion                                                 |

### Header Example&#x20;

Example header with partner authentication token, task ID and user's Telegram UserID.

**Authentication token:** mrcrypto

**Task ID:** 201

**Telegram UserID:** 1234567

`curl -X GET -k -H 'Auth: mrcrypto' -i 'https://GAMEE-API-HERE.com/taskApi.php?taskId=201&telegramUserId=1234567`

### **Responses:**

Success response: `{"status":"ok"}`

Error response: `1 error: {code: int, message: string}`

### List of Error States:

<table><thead><tr><th>Code</th><th>Message</th><th data-hidden></th></tr></thead><tbody><tr><td>999</td><td>Invalid type parameters</td><td></td></tr><tr><td>999</td><td>Invalid Auth Header</td><td></td></tr><tr><td>-32001</td><td>Telegram Task not found</td><td></td></tr><tr><td>-32001</td><td>Telegram User not found</td><td></td></tr><tr><td>-32001</td><td>Invalid telegram user</td><td></td></tr><tr><td>999</td><td>Task completion failed</td><td></td></tr></tbody></table>

### Example Calls:

<table><thead><tr><th width="99">taskID</th><th width="115">auth</th><th width="181">response</th><th>curl</th></tr></thead><tbody><tr><td><code>201</code></td><td>mrcrypto</td><td><code>{"status":"o k"}</code></td><td><code>curl -X GET -k -H 'Auth: mrcrypto' -i 'https://api.GAMEE-API-HERE.com/taskApi.php?taskId=201&#x26;telegramUserId=1234567'</code></td></tr><tr><td><code>201</code></td><td>mrcrypto</td><td><code>{"error": {"code":-32 001,"mess age":"Tele gram user not found"}}</code></td><td><code>curl -X GET -k -H 'Auth: mrcrypto' -i 'https://api.GAMEE-API-HERE.com/taskApi.php?taskId=201&#x26;telegramUserId=157'</code></td></tr></tbody></table>

### **Ready to collaborate?**&#x20;

Please fill in this [contact form](https://bit.ly/collab-gamee-and-you) and we will respond as soon as possible.

![page2image44109680](blob:https://app.gitbook.com/ff501958-f853-4a5b-bfad-37c92ea3d8d7) ![page2image44109888](blob:https://app.gitbook.com/3731db36-cc41-45a4-bcdf-45fc0ba62593)