Flourish Software External API Key Management

Flourish Software previously supported generating External API keys at the user level. While this method is still available, we highly recommend transitioning to the new service-based API key management, as the legacy approach will be sunset at July 2026.

For now, use the legacy method only for certain partner integration.

Previous vs. New API Key Management

Key reasons to adopt the new method:

• Not tied to individual users—no disruption if users leave or are deactivated.
• Enhanced security—API access is scoped to only the services and data needed.
• Easier to manage—centralized and consistent key control.

Prerequisites

To manage API keys, your user role must have 'Update' access to Integrations. Follow these steps:

1. Go to Settings → User Roles – Open the User Roles section from Settings.
2. Select the Facility – Choose the facility where you want to manage roles.
3. Select the Role – Pick the specific user role to update.
4. Locate the Admin card – Within the configuration, find the Admin permission card.
5. Enable 'Update' access for Integrations – Ensure the 'Update' checkbox is selected.
6. Click Save – Save your changes to apply the new permission settings.

API Keys Management

Generate a New API Key

1. Go to Settings.
2. Select Integrations.
3. Click the pencil icon on the "API Keys" card.
4. Click the ‘+’ icon on the top right to create a new API Key.
5. Provide:
   • Name
   • Description
   • Expiration Date (via quick selectors or date picker)

   

6. Set permissions—choose one of two methods:

   

   1. By Modules and Locations (Default)

      

      1. Select MODULES. For each module, check boxes under Read, Create, or Update.
      2. Locations: Select specific facilities or choose "All Facilities".
   2. By EndPoints and Locations

      

      1. Select ENDPOINTS.
      2. Check boxes under Company Endpoints and Facility Endpoints, or use "All".
      3. Locations: Select individual facilities or "All Facilities".
7. Click CREATE.
8. Copy the newly generated API key.
9. Click THANKS to finish.

Manage API Keys

Copy, Refresh, and Delete

1. Go to Settings → Integrations.
2. Click the pencil icon in the "API Keys" card.
3. Use the three-dot menu on the right:
   • Copy the API Key.
   • Refresh:
     • Generates a new key with the same settings.
     • Set a new expiration.
     • Click REFRESH—the old key becomes invalid.
   • Delete:
     • Confirm the deletion.
     • Access is revoked for any services using this key.

Edit the API Key

• Click the key’s name, expiration, or created date to open its details.
• Options:
  • Edit the metadata and save.
  • Delete the key.
  • Refresh:
    • Save changes before refreshing.
    • If not saved first, the refresh uses the original settings.