Application programming interface (API) specification
API could be used for challenges designed to reward individuals for actions happened outside Aimera. For example:
- Try a mobile app
- Try feature X
- Do some action 5 times
- Do something once in a week
This open API lets any partner notify Aimera about such events happened for further processing. To integrate one challenge just several lines of code are needed. Depending on the complexity to integrate one challenge it takes about 2-3 hours for mid-level developers.
How it works
Suppose there is a challenge created for Aimera member to sign up for mobile application. This action will trigger some bonuses which are managed by Aimera. Aimera should know about the user who has launched application for the first time.
To track the sign up (let’s call it generically - Event) the signal must come to Aimera from any system which knows when the user signed up for the application. Alternatively you may use manual import.
Internally provided libraries encrypt Event data using AES-256 algorithm with a pre-shared secret key.
Events can be sent multiple times. It will be processed by Aimera once or multiple times depending on the challenge setup.
Tracking code snippets
Manual event import
Implementation of API requires some technical work. A manual import could be used instead of automatic data exchange.
For manual import please find "Import API events" on the challenge page in management panel. This button is available for "API event" challenge types only.
In the opened form simply copy and submit all phone numbers of people who did action. In the taken example, that were people who signed up for mobile app.
The system will process the list identically as it would do programmatically. It will accept numbers of Aimera members and reject the rest. As there are more factors, Aimera will internally process all accepted numbers evaluating whether or not a person should be rewarded.
