Ecwid pricing includes four tiers: Free, Venture, Business, and Unlimited. The API is available on any paid Ecwid plans, i.e. Venture, Business, and Unlimited.
Clients on Free plans cannot use Ecwid API. This means that, if the user is on the Free plan, all API functions will fail including requests to read or update store data, embedding app interfaces into Ecwid Control Panel, and customizing the storefront.
If you’re building an app for our App Market, we would be happy to provide you with a paid Ecwid account for free for development and testing purposes.
Feel free to contact us, provide the details of your application and we will help you. Please note that this account must not be used for selling the application or any other products to real customers.
Get application
To access Ecwid API, you need an application.
Applications in Ecwid stores grant API keys and access tokens that are used to interact with a store via Ecwid API. These applications act like a gate to Ecwid API, they don't do anything on their own, so you must develop a code for every functionality you want to add.
Find more information about API keys and access tokens here: Authentication basics
Hosting
Your app can use multiple API features at once. For example, it can add a new payment method to the store and receive webhooks for new orders. Many features (like webhooks or Payment API) require external endpoints, which are provided by the application developer.
Since Ecwid does not have any hosting for application files, you must host them in your preferred secure environment. When you have working URLs for application endpoints, request an application update.
Choose API features
Access to different zones of our API is gated behind access tokens. This way a payment application won't be able to access your customer's data, and your storefront customization app won't be able to create orders.
Before developing your solution, request your app to be updated by the Ecwid team with the corresponding API features: Application update
Choose application type
The Ecwid platform provides two ways of installing and operating applications in an online store: native and external apps.
Native apps work solely in the Ecwid Control Panel by adding a new tab into one of its sections. When a user visits that tab, Ecwid will load the app page in an IFRAME window. The app can interact with a store (get access token, get store information) and with the Ecwid Control Panel using Ecwid JS SDK.
External apps work outside of the Ecwid Control Panel on an external website or in the background with no setup required. These applications need to handle the oAuth process themselves in order to get an access token. Usually, they work on the server side with their own database to store the access tokens of their users’ stores.
Custom apps work inside a specific Ecwid store, so they don't need to handle oAuth at all and don't need a settings page (they can still have one if needed). Access token can be retrieved from the Control Panel, so the API access
If you are not sure what application type suits your needs the most, contact us at [email protected]