Creating and managing API Keys

About API Keys

Boards on Fire provides a REST API for reading, creating, updating, and deleting data. To authenticate and access the API without using your personal username and password, you can create one or more API keys.

API keys are ideal for:

• Automating integrations with external systems (e.g., SAP)
• Running scheduled scripts

You can create multiple keys for different integrations and restrict key’s usage to specific IP addresses if needed.

Before you can create an API key, External API access must be enabled for your environment.
If it is not yet enabled, please contact our Customer Success team.

How to create an API Key

1. Log in to Boards on Fire.
2. Go to Integration → API Clients in the main menu.
3. Click Add API Client and provide:
• Name – A descriptive name for the integration (e.g., "SAP Connector")
• Contact Person – The person responsible for this integration
• Email – Email to contact person
• Allowed IP addresses (optional) – Limit access to specific IP addresses
4. Click Add API Client to proceed.
5. Click Add API Key and provide:
• Name - A descriptive name for the API Key (e.g., "Production")
• Valid for – Choose an expiration date that fits your security policy
6. Click Create API Key.
7. Copy the key and store it securely.

Important: Once displayed, the API key will not be shown again. If lost, you must generate a new one.

Best Practices for API Keys

• Secure storage: Store your key securely (e.g., in environment variables or a secure vault). Never include it in client-side code or public repositories.
• Separate keys: Use different API keys for different environments (development, staging, production) or integrations.
• Rotate when needed: If you suspect a key has been compromised, revoke it and generate a new one immediately.
• Limit scope: Use IP restrictions whenever possible to limit where the key can be used.

Using the API Key

When making requests to the Boards on Fire REST API, include your API key in the request header:
x-api-key: YOUR_API_KEY