API Access Key

Who can use this feature: Admin, Manager

Your API access key is required to authenticate with the Flarie API and should be included as the accessKey parameter in the payload. 

For webhook requests sent from Flarie, a Bearer token is included in the Authorization header, formatted as Bearer <accessKey>. While optional, verifying this token on your server adds a layer of security by confirming that the request originated from Flarie.

How to create an API Access Key.

  1. Navigate to 'Access Keys' in the menu.

  2. Click on 'Generate Key' to generate a key.

  3. 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 Access Keys by expanding the menu.

  2. Generate and copy the key to use it

  3. If an API Secret Key has already been generated, generating a new one will invalidate the old key.