Yet, many beginners still don’t know how to generate the API key properly, and that’s why we’re here to help. In this guide, we’ll walk you through the key steps:
- Step 1. Log in to your Ecwid Admin Panel
- Step 2. Create a custom app and configure permissions
- Step 3. Request missing permissions (optional)
- Step 4. Install the app and retrieve the secret token
Let’s begin!
How to Get Ecwid API Key
To generate an Ecwid API key, you need to create a custom app in your Ecwid admin panel, configure the required permissions, and retrieve the token generated for that app. If some permissions are not available by default, you may need to request them from the Ecwid team before reinstalling the app and copying the token for integration.
Step 1. Log in to your Ecwid Admin Panel
First, log in to your Ecwid account and access your store’s admin dashboard. From here, you will be able to manage integrations and create a custom app that generates the API credentials needed for external connections.
Make sure you are logged in to the correct store before proceeding to the next steps.
Step 2. Create a custom app and configure permissions
Next, go to the custom app creation page and create a new app for your store.
During this step, you need to configure the app permissions so it can access the required store data. So, ensure that the app includes all the permissions below:
read_customers, read_brands, create_catalog, update_subscriptions, read_discount_coupons, create_discount_coupons, update_catalog, public_storefront, customize_cart_calculation, update_discount_coupons, delete_staff, read_store_limits, create_customers, read_catalog, update_customers, read_orders, read_staff, add_payment_method, create_orders, read_subscriptions, update_orders, read_store_profile, add_shipping_method, invite_staff, update_store_profile.
These permissions allow the system to retrieve and update store data necessary for integrations and operations.
Step 3: Request missing permissions (optional)
If some of the required permissions are not available when creating the app, you will need to request them from the Ecwid team.
To do so, scroll down to the section “Request Ecwid team to update app details & add new features” and click Contact. In the message field labeled “Type your answer here…”, list the permissions that are missing, then click Submit to send your request.
Once Ecwid approves and updates the permissions, you will be able to proceed with installing the app.
Step 4. Install the app and retrieve the secret token
Now, after the permissions have been updated, uninstall the app from Apps → My Apps. Then reinstall it through the develop-apps section in your Ecwid account (https://my.ecwid.com/#develop-apps).
Once the app is installed, click the “Show secret token” button to reveal your token. Finally, copy this value and paste it into your document, note, etc., to save it and/or use it later on.
Note: Make sure to keep this token secure and only share it with trusted services.
Why You Need to Get The Ecwid API Key
People need Ecwid API integration for the following reasons:
- Data migration to another eCommerce platform: The API key allows migration tools to securely access your Ecwid store data, including products, customers, orders, and other essential information. This stage is especially necessary when transferring your store from Ecwid to another platform, such as Shopify, WooCommerce, or Magento, as it ensures the migration runs automatically and accurately.
- Running Ecwid API integration with third-party services: Many external tools, such as marketing platforms, inventory management systems, or analytics tools, require API access to retrieve or update store data. The API key acts as an authentication method that allows these services to communicate with your Ecwid store securely.
- Automating store operations: Developers and businesses often use the Ecwid API to automate tasks such as syncing products, updating inventory, processing orders, or managing customer data. With an API key, these processes can be performed programmatically rather than manually in the admin dashboard.
- Building custom integrations or applications: If you want to develop a custom app or integrate Ecwid with your own internal systems, the API key provides the necessary credentials to interact with Ecwid’s API endpoints. As a result, you can extend your store’s functionality beyond the default Ecwid features.
Common Errors When Generating Key for Ecwid API Integration
Though generating an Ecwid API key is generally straightforward, users may occasionally encounter issues during the process:
Missing required permissions in the custom app
As mentioned earlier, one common problem occurs when the custom app is created without all the necessary permissions. Since API access depends on these permissions, missing scopes can prevent external tools from retrieving or updating store data properly.
To resolve this issue, you need to review the permissions assigned to your custom app and make sure all required scopes are included. If certain permissions are not available in the list, scroll down to the “Request Ecwid team to update app details & add new features” section, click Contact, and submit a request listing the missing permissions.
Secret token not visible or cannot be retrieved
In Ecwid, the API key is displayed as a Secret Token, and it is hidden by default for security reasons. If the app installation was incomplete, the token might also fail to appear.
In that case, you should open your custom app again in the Ecwid admin panel and click the “Show secret token” button to reveal the key. If the token still does not appear, uninstall the app from Apps → My Apps, then reinstall it through the develop-apps section. This should regenerate the token and make it accessible.
Using an outdated or invalid API token
Sometimes the API token stops working even though it was previously copied correctly. This problem usually occurs when the app has been modified, reinstalled, or recreated, which generates a new token and invalidates the previous one.
If this happens, return to the custom app settings in your Ecwid admin panel and retrieve the latest Secret Token. Then, replace the old token in the tool or service you are connecting to your Ecwid store.
Ecwid API Integration: FAQs
What is Ecwid API key?
It is an authorization key used to make requests to the Ecwid REST API to manage store data (products, orders, etc.). It authenticates your application or service with a specific store.
How do I get an Ecwid API key?
Log in to your Ecwid admin, go to the "Develop Apps" section, and create your first app. Your access tokens (public and secret) will be automatically generated and displayed on the app details page.
Can I use the same token for different stores?
No, an access token from one store will not work for another store.
What if my token is compromised or I need new permissions?
You can revoke the old token by uninstalling the app from the Ecwid admin and then reinstalling it to generate a new one.
Final Words
Overall, generating the key for Ecwid API integration requires you to create a custom app, assign the appropriate permissions, and retrieve the app’s secret token.
Throughout this guide, we’ve walked through each stage so you can complete the process without confusion. From here, it will be easier for your team to move forward with integrations, automation, or store migration when needed!
