Custom API Configurations

Verify any action performed on a third-party application via their APIs

This action type lets event organizers configure the verification and rewarding of actions performed on third-party applications. (Example: Get extra 30 points for registering an account on the XYZ application)

How it works?

An organizer has to implement an API (GET or POST HTTP methods) for verifying certain data provided by participants in an event configured in Fyre. The API can then be configured under "Custom API Configuration" section.

The process is very simple:

1) Participants provides data (requested by the organizer)

2) Fyre's server call the configured API.

3) The 3rd party API server verifies the data and responds to the Fyre server.

4) Upon successful verification (as configured in the Fyre dashboard), the user claims the reward/points.

Example

Let's us say for example, an organizer wants to reward participants who have downloaded their app and created an account. The organizer first develops a GET or POST API (say POST) and enters the API endpoint in the API Endpoint field and selects HTTP method as POST.

Make sure to whitelist origin https://app.fyre.hypersign.id in your server

Upon selecting HTTP method, fields configuration section appears where the organizer has to configure API request body or query params fields. The Fyre server will take participants inputs in its UI and populates these fields while making the API call to the 3rd party app's server.

Organizers may also request participants to provide blockchain wallet addresses. Currently we support EVM and Cosmos based chains. Click on type to see the list of supported blockchains.

Optionally, you may also configure Headers in the form of JSON

Now configure the "Condition" which you want Fyre's server to verify. Say you want Fyre's server to assert that response is of type boolean and the value is true.

You may configure complex condition using regular expression condition.

Finally enter the "Error Message" , you want to show to your participant upon failed verification:

Enter the Score and click on "Add" to save this configuration.