Home
Getting Started

Authentication

Every request to the Invoice Falcon API must include your store's API key in the X-Auth-Token header.

Every request to the Invoice Falcon API must include your store's API key in the X-Auth-Token header.

Obtaining your API key

API access is available on paid Invoice Falcon plans. Requests from stores on the free plan return 403 Forbidden.

  1. Open the Invoice Falcon app from your Shopify admin.
  2. Go to Settings > Integrations.
  3. Click Generate API key.

Your key will look like if_api_key_ followed by a random hex string.

Using the key

Include the header in every request:

curl -H "X-Auth-Token: if_api_key_abc123..." \
  https://app.invoicefalcon.com/api/v1/external/invoices

Security

  • Keep your key secret. Do not expose it in client-side code or public repositories.
  • You can regenerate your key from the same Settings page if you suspect it has been compromised. This immediately invalidates the previous key.
  • Each API key is scoped to a single Shopify store.