API keys
Quick answer
Owners and admins create API keys in Settings → Workspace → API Keys with Create Key, and must copy the key when it is shown because it cannot be viewed again. Every key has full access to the workspace's API; Premium includes 3 keys, Premium Plus 10, and Free and Pro none.
How do I create an API key?
Who can create keys
Owners and admins can create keys. Free and Pro include no API keys, Premium includes 3 and Premium Plus 10. If your quota is full, Shopfront shows a limit dialog with the plans that include more keys. See Billing and usage limits.
Open API Keys. Open Settings → Workspace → API Keys and select Create Key.
Name the key. Enter a Key Name in Create API Key and select Create Key.
Copy the key. Copy the key from API Key Created before you close the dialog: you cannot see it again. The list shows only the start of each key.
Can I restrict what a key can do?
No. Every key has full access to your workspace's API. The key name is only a label.
How do I revoke or delete a key?
Open the key's menu:
- Revoke key asks you to confirm Revoke Key in Revoke API key?. Any application using the key loses access immediately.
- Delete key permanently removes a key after a separate confirmation.
If you lose a key or think it has been exposed, revoke it and create a new one.
See the API Reference for authentication and endpoints.
Notifications
Open Notifications in the sidebar to see your Inbox of sales, offers and job updates from the last 30 days, filter by status, channel or type, and use Mark all read or Clear all. Clearing your inbox does not affect other members of your workspace.
Public API
The API Reference documents the Shopfront public API at https://api.shopfront.app, with the OpenAPI file at https://docs.shopfront.app/api/openapi.yaml; send your API key as a bearer token, and GET /v1/health needs no key. POST /v1/products/generate is retired and returns 410 Gone, so use POST /v1/listings/generate.