Access Key

Access Key

In the Brand Settings, you can change settings related to your brand. Here you can find:

  • API Access Key

  • API Secret Key

 

API Access Key

Who can use this feature: Admin, Manager

Your API access key is essential for authenticating with the Flarie API. It should be specified as the ‘accessKey’ parameter in the payload for external gamification events. 

For webhooks, authentication is managed through a bearer token, formatted as “Bearer <accessKey>“. This is adding an authentication layer that verifies requests originate from Flarie.

 

 

How to get an API Access Key.

  1. Navigate to API Access Key by expanding the menu.

  2. Generate and copy the key to use in your API. If an API Access Key has already been generated, generating a new one will invalidate the old key.

 

 

API Secret Key

Who can use this feature: Admin, Manager

Your API secret key plays a crucial role in securing your webhook payload by generating a hash, ensuring the request originates from Flarie and remains unaltered. This hash, formulated as SHA-256 (payload + secretKey), is included in the headers under the X-Signature attribute, providing an added layer of verification and integrity protection.

The Secret Key is optional. 

 

 

How to get an API Secret Key.

  1. Navigate to API Access Key by expanding the menu.

  2. Generate and copy the key to use itIf an API Secret Key has already been generated, generating a new one will invalidate the old key.