👨‍💻API Key Management

Fuul provides four types of API keys, each tailored to specific use cases based on your project’s requirements. These keys enable secure interaction with the Fuul platform and should be used appropriately to ensure data integrity and system security.

1. Read-Only

The Read-Only API Key is used to fetch data for display purposes, such as in front-end applications. For example, this key is ideal for showing a leaderboard or displaying information about conversions and rewards on your website. It only retrieves information and cannot modify or send data.

2. send:tracking_event

The send:tracking_event API Key is also suitable for front-end use. In addition to showing information about conversions and rewards, it allows you to send tracking events like pageview or connect_wallet. This key is designed to interact with basic user activity data while maintaining security.

3. send:trigger_event

The send:trigger_event API Key is exclusively for back-end use. It allows you to send and receive custom trigger events and conversions, such as actions performed in Twitter or Discord communities.

Do not use this key in the front-end, as exposing it could allow malicious users to send false events, compromising the integrity of your program.

4. service_role

The service_role API Key is used for creating or updating program information, specifically for audience management.

This key is strictly for back-end operations and should never be exposed in the front-end.

For more details on managing audiences, visit this page.

Use these API keys based on your project’s specific needs, ensuring they are implemented securely and in line with their intended purpose.

Creating your API Key

To create an API key go to Settings > New API Key

Then select the type of API Key you want to create, name it and hit Create.

You will see a modal with your new API Key. Make sure to copy it.