Skip to main content
All API requests require an API key for authentication. You can create and manage keys from your EcomWize dashboard.

​
Create an API key

1

Open API Keys

In your EcomWize dashboard, click API Keys in the sidebar.
2

Click Create API Key

Click the + Create API Key button in the top right.
3

Name your key

Give your key a descriptive name (e.g., “Production automation” or “Staging tests”).
4

Choose permission

Select the permission level:
  • Full access — can read and edit pages (fill, duplicate)
  • Read only — can only list and retrieve pages
5

Copy your key

Your API key is displayed once. Copy it immediately and store it securely. You will not be able to see it again.
Never share your API key or commit it to source code. Treat it like a password. If a key is compromised, revoke it immediately from the dashboard and create a new one.

​
Using your key

Include your API key in every request using the Authorization header:
You can also use the x-api-key header as an alternative:

​
Key format

All EcomWize API keys start with the ew_live_ prefix followed by 32 hexadecimal characters:

​
Permissions

If a read-only key is used on a write endpoint, the API returns a 403 error.

​
Revoking a key

To revoke an API key:
  1. Go to API Keys in your dashboard.
  2. Click the … menu on the key you want to revoke.
  3. Click Revoke Key and confirm.
Revoked keys stop working immediately. Any integrations using that key will receive a 401 error.

​
Security

  • API keys are hashed before storage. EcomWize never stores your raw key.
  • Failed authentication attempts are rate limited to prevent brute force attacks.
  • All API requests are logged with timestamps, IP addresses, and status codes for your security.