Skip to main content

🔑 API Keys

Manage API keys for integrating external systems with RepairMinder.

What Are API Keys?​

API keys authenticate external applications to access RepairMinder data:

  • Website integrations
  • Custom applications
  • Third-party services
  • Automation tools

Viewing API Keys​

  1. Go to Settings → API Keys
  2. See all active keys
  3. View key details and usage

Creating an API Key​

  1. Click Create API Key
  2. Enter a name (describes what it's for)
  3. Select permissions (what the key can access)
  4. Click Create
  5. Copy the key immediately (won't be shown again)

Naming Keys​

Use descriptive names:

  • ✅ "Website Contact Form"
  • ✅ "Zapier Integration"
  • ❌ "Key 1"
  • ❌ "Test"

API Key Permissions​

PermissionAccess
Read OrdersView order data
Write OrdersCreate/update orders
Read ClientsView client data
Write ClientsCreate/update clients
Read DevicesView device data
Write DevicesAdd devices to orders

Grant only the permissions needed.

Securing API Keys​

Keep Keys Secret​

  • Never expose keys in client-side code
  • Don't commit keys to version control
  • Use environment variables
  • Share keys only with trusted systems

IP Restrictions​

Limit which IPs can use a key:

  1. Edit the API key
  2. Add Allowed IPs
  3. Only those IPs can use the key

Key Rotation​

Regularly rotate keys for security:

  1. Create a new key
  2. Update your integration
  3. Verify it works
  4. Delete the old key

Monitoring Key Usage​

View how keys are being used:

  • Request count
  • Last used timestamp
  • Endpoint access
  • Error rates

Revoking API Keys​

If a key is compromised or no longer needed:

  1. Find the key
  2. Click Revoke
  3. Confirm

The key stops working immediately.

Rate Limits​

API keys are subject to rate limits:

  • 100 requests per minute
  • Exceeding returns 429 error
  • Implement backoff in your code

API Documentation​

Full API documentation is available:

  1. Go to Settings → API Keys
  2. Click API Documentation
  3. Browse endpoints and examples

Testing API Keys​

Test keys before production:

  1. Create a test key
  2. Use the test environment
  3. Verify everything works
  4. Create production key

Troubleshooting​

Key Not Working​

  • Check key is copied correctly
  • Verify key has correct permissions
  • Check IP restrictions
  • Ensure key isn't revoked

Getting 401 Errors​

  • Key is invalid or expired
  • Check Authorization header format
  • Verify key permissions

Getting 429 Errors​

  • Rate limit exceeded
  • Slow down requests
  • Implement retry with backoff

Best Practices​

✅ Do​

  • Use descriptive key names
  • Grant minimum necessary permissions
  • Rotate keys regularly
  • Monitor key usage

❌ Don't​

  • Share keys in public repositories
  • Use the same key for everything
  • Ignore revoked key warnings
  • Grant full permissions unnecessarily

Next Steps​