Welcome, developers!

This is an introduction to the Earn Alliance API. Use the sidebar to explore and learn about important concepts.

The Earn Alliance API can be used to integrate your own game or custom events, with the Earn Alliance missions system, and unlock powerful features for user aqusition and retention.

The API closely follows REST semantics, uses JSON for data structure, and implements encoded signatures to validate the data integrity.

How does it work?

Start by defining the custom mission or objective you want to achieve within your game. This could be anything from tracking user signups, monitoring progress within the game, or reacting to specific conditions.

Here is an example of a custom mission to "Build City Defence" added to a Free Mint on our platform.

Once you know what kind of mission you want to give your users, you need to determine what custom events needed to represent the specific occurrences or milestones within your game. These events can be triggered at any point in the application's execution and can carry additional data or parameters.

Within your application's codebase, you need to implement the logic to trigger these custom events at the appropriate times. This can be done by calling the event with its defined name and providing any necessary data or parameters.

By leveraging custom events, you as developers have the flexibility to create custom missions tailored to your specific requirements. These missions can be dynamic and responsive, allowing the application to react to user actions, system events, or any other relevant triggers. Custom events provide a modular and extensible approach to implementing complex workflows and behavior within an application.