Skip to main content

Authentication

To interact with the Reflectfy API, you'll need an API key that authenticates your requests. This page will guide you on how to obtain your API key and use it to authenticate your API requests.

Getting Your API Key​

To get your API key, follow these steps:

  1. Log in to Reflectfy:

    • Go to Reflectfy and log in with your account credentials.

  2. Navigate to the API Key Section:

    • After logging in, head to the API Keys section in your workspace settings.

  3. Generate Your API Key:

    • Make sure to store this key securely, as it will be used to authenticate your API requests.

Using Your API Key​

Once you have your API key, you need to include it in the header of your API requests to authenticate your access. The key should be passed as a value to the X-API-KEY header.

Example Request​

Here’s an example using curl to test your API key:

curl -L 'https://reflectfy.com/api/auth/portal/v1/me' \
-H 'Accept: application/json' \
-H 'X-API-KEY: [APIKEY]'

Replace [APIKEY] with your actual API key.

Response If your API key is valid, the request will return a response with your account information. If the key is invalid or missing, you'll receive an authentication error.

Best Practices Keep Your API Key Secure: Treat your API key like a password. Do not expose it in public repositories or share it with unauthorized users. Regenerate When Necessary: If you suspect your API key has been compromised, regenerate a new one from your account settings immediately. For any questions or issues related to API authentication, please contact our support team at support@reflectfy.com.