Configure the plugin settings and customize behavior through the Strapi admin panel
Initial Setup
1. Enable Permissions
After installation, navigate to Settings → Users & Permissions → Roles and select the Public role.
Under the WebbyCommerce section, enable the Enable permission to allow access to ecommerce API endpoints.
Configure Tab
Allowed Frontend Domains
Add your frontend domain(s) for CORS and security validation.
API Route Prefix
Customize the API route prefix (default: webbycommerce).
Examples: /api/ecommerce, /api/v1, /api/shop, /api
SMTP Configuration
Configure email settings for OTP and notifications.
- Host, Port, Secure (TLS)
- Username, Password
- From Email and From Name
Login/Register Tab
Authentication Method
Choose between different authentication approaches:
Default (Email/Password)
Uses Strapi’s built-in authentication system with email and password.
OTP (Email/Mobile Verification)
One-time password authentication via email or mobile verification.
Shipping Type Tab
Single Address Mode
Users can have only one billing and one shipping address. This is useful for simpler checkout flows.
Attempting to create duplicate address types returns 403 Forbidden
Multiple Address Mode
Users can create unlimited addresses. This provides more flexibility for users with multiple delivery locations.
Users can manage multiple billing and shipping addresses
SMTP Tab
How to Configure (Admin UI)
- Go to Settings → WebbyCommerce → SMTP.
- Fill in Host, Port, Secure (TLS), Username, Password, From Email, and From Name.
- Click Save and Restart Strapi.
Do not commit real SMTP credentials. Use environment variables in production.
Testing
- After saving, send a test OTP or notification from your flow to verify delivery.
- Check your SMTP provider logs if emails are not received.
- Ensure From Email is verified with your provider (some providers require domain verification).
Environment Variables (Recommended)
Map your SMTP settings to env vars for security:
WEBBY_SMTP_HOST=smtp.sendgrid.net
WEBBY_SMTP_PORT=587
WEBBY_SMTP_SECURE=false
WEBBY_SMTP_USER=apikey
WEBBY_SMTP_PASS=<sendgrid-api-key>
[email protected]
WEBBY_FROM_NAME=Example Store
The plugin reads these values when configured to use env-backed settings.
Address Content Type Configuration
The plugin creates an Address content type automatically with the following fields:
Required Fields
type(integer, 0=billing, 1=shipping)first_name(string)last_name(string)country(string)city(string)street_address(text)postcode(string)phone(string)email_address(email, required for billing addresses)
Optional Fields
company_name(string)region(string)
Relations
user(manyToOne → plugin::users-permissions.user)
Important: All configuration changes require restarting Strapi to take effect. After making changes in the admin panel, restart your Strapi server.