API
This page lists all available APIs
Beintoo Gamification and Rewarding APIs are REST services, query enabled through a GET operation. The integration is straightforward and you can decide the level of complexity. Have a look at Resource.
We suggest that you start with the basic integration and gradually strengthen it. This way you can start immediately distributing rewards and monetizing your traffic.
The basic integration involves the following API calls:
- Player.login
- Player.submitscore
- Vgood.getVgoodbyGuid
- Vgood.by user
Notice that a user cannot receive more than N goods per day or M per minute, although this limitation is relaxed within the sandbox enviroment, in order to help you develop faster.
Beintoo APIs allow you to create a diversified gaming and rewarding experience within mobile and web apps.
The three key APIs to start delivering branded virtual goods as rewards are the following:
Player.login: you open a session for each Beintoo user
Player.submitscore: you submit the score that you would like to provide to Beintoo as the key scoring parameter. It can be for example a counter on a specific operation such as a sharing, or it can be your own score in case of a game, it is up to you. Beintoo will take into account this variable and the frequency of usage to rank the app users and provide a leaderboard thanks to its innovative and proprietary reputation algorithm.
Vgood.getVgoodbyGuid: is the key api call to provide a reward to the user. You decide what the user actions and achievements are that can activate this call within your app. We will deliver the reward through our optimization engine, trying to identify a good with the highest probability of conversion.
Vgood.by user: this api call provides you with the list of cross-app rewards owned by the user. We suggest that you to implement the feature “virtual wallet” where the user can check his portfolio of rewards within your app. This will increase the probability that the user makes a conversion starting from your app even if he received the converted reward in another app. This means more probability of revenue for you.
Here is another set of tricks that we recommend to all of you:
Ideally the user should often be connected to the Internet when using your app
The player.login call, should be executed as soon as the user opens your app
We need to identify the user in order to build a cross app profile. It means knowing his interests so as to increase the probability of conversion. It definitely means increasing your revenues. We suggest you launch a getvgood call for each new anonymous user so that we lead him to provide an email address and at that point allow us to recognize him cross-app. Once the user is identified within Beintoo, we ensure you that we will deliver the best possible goods.
When you request an API key, you have to specify to us whether your app is what we call a “Best Performance” App or an “Incremental” App.
The first one includes mobile and social casual games and more generally all apps where the variable sent by the player.submit score call is related to the current session. The latter one includes mobile and social games and all other apps where the variable sent by the player.submit score call is cumulative (there is memory within the app).
We suggest that Best Performance App developers call the getvgood API upon the following achievements: getting a special element during the game (such as a star or a special weapon), completing a level, buying premium features or virtual goods, being in the leaderboard of top users in a day/week or accessing the app at least 3 times in a week.
We suggest that Incremental App developers call the getvgood API upon the following achievements: accessing the app at least 3 times in a week, completing a level, being in the leaderboard of the top users in a day/week.
A specific case is represented by Location-Based Apps, where there is for example the concept of “map”. In this case the achievement that triggers the getvgood API call could be the geographical presence in a specific area. Moreover we offer location-based app developers two very interesting apps: vgood.checkinplaces and vgood.checkin. These two APIs allow the developers to show their Beintoo partners physical stores and related coupon offers on a visual map. Users can go to the physical store and checkin to receive the reward.
We strongly recommend to all developers that they implement the concept of the “virtual wallet”. You can use the vgood.byuser API call and get the list of all rewards for a specific user. The user can see his prizes within your app and download the related coupons increasing your revenues. This is one of the key features with which developers can monetize.
Functional values of rewards: this recommendation is valid especially for mobile game developers. With the App.topvgood call you can get the list of rewards which are generating more revenues for your app. You can use this information to provide a functional advantage to all users who own those specific rewards.
