API keys

Written By Ignacio

Last updated 2 days ago

API keys let other software talk to your Flyra data. Most businesses never need one. If you're wiring up a custom dashboard, a data warehouse or an automation tool, this is where you start.

It's Settings > Developer.

The Developer settings page

1. Generate

Creates a key.

Copy it immediately and store it somewhere safe. Keys are shown once, and if you lose it you generate a new one rather than recovering the old one.

Treat a key like a password with no expiry: it's a way into your customer list, your revenue and your job history.

The Generate button

2. Grant all

Switches on every scope in one click.

Convenient, and rarely the right choice. A reporting dashboard that only reads job totals has no business holding a key that can delete customers. If the integration breaks or the key leaks, the damage is whatever you granted.

The Grant all button

3. Read-only all

Every read scope and no write scopes. This is the sensible default for anything that only looks at data: dashboards, spreadsheets, warehouse syncs.

Start here. Add write scopes individually only when something genuinely needs to change data.

The Read-only all button

4. Per-scope switches

Individual toggles for each scope, which is how you build a key that does exactly one job.

The habit worth having: one key per integration, scoped to what that integration does. When you retire the tool, you revoke one key and nothing else breaks. A single shared key across three tools means you can't revoke anything without breaking everything.

The scope switches

Tips and gotchas

  • Copy the key when it's shown. You won't see it again.
  • Read-only unless writing is required.
  • One key per integration. Makes revoking safe.
  • Never put a key in a browser or a shared document. It's server-side only.
  • Rotate when someone with access leaves.

Next up: Preferences and notifications