Customer Approval
Overview
Managing customers from the beginning will help you control your website well, gain profits, and obtain certain customer trust. With Mageplaza's Customer Approval extension, you can definitely do that. Admin will receive an email notification when a customer successfully registers for an account, and he/she can choose auto-approve or manually approve. Accordingly, your customers will receive email notifications of successful signing up for an account, whether it is successfully approved or not approved. You should install Mageplaza SMTP to avoid your email being sent to the spam box, and it is fully compatible with the Customer Approval extension.
Outstanding features
Outstanding features | Description | |
---|---|---|
1 | Manage customer account registrations by setting automatic or mass approval | This extension allows the admin to approve or reject new account registrations from customers in specific cases. In addition, automatic installation or mass approval can significantly reduce the amount of work for customers using the module. |
2 | Provide a user-friendly experience | In addition to providing transparent information when approving customers, the module also helps to continuously update customer account status via email. Moreover, the plugin also updates through many different methods, such as direct messages on the store and redirecting to another page |
3 | Show an error notice to explain the customer's status | This feature helps customers as well as admins know the details of registration errors, thereby providing appropriate solutions. |
Installation
We offer two methods for installing our plugins: the Copy & Paste method and the Composer method. Please follow the detailed instructions provided below.
Method 1: Installation via Copy & Paste
To install our plugins using the Copy & Paste method, kindly follow the instructions at the link below:
How to Install Magento 2 Extension via Copy & Paste
Method 2: Installation via Composer
Composer name: mageplaza/module-customer-approval
To install our extensions using Composer, please refer to the comprehensive guide at the link below:
How to Install Magento Extension via Composer
By following these guides, you can ensure that the installation process is handled correctly, allowing you to fully utilize the features and benefits of our plugins.
Module Update Guide
Keeping your module updated ensures optimal performance. Follow one of these steps to update your module:
- By Account Dashboard: Log in to your
Mageplaza account > My Licenses > Download > choose the latest version from the popup
. - By composer: Kindly use the following commands to update the module via composer
composer require mageplaza/module-customer-approval
php bin/magento setup:upgrade
php bin/magento setup:di:compile
Updating a module by Composer ensures efficient dependency management, version control, and integration with development tools, making the process faster and more reliable.
How to use
Approval Account Notification: Show the notification when customers have registered accounts and are waiting for approval
[Customer] Successful Register: Send notification emails to customers when they have registered the accounts successfully
[Customer] Approve Notification: Send notification emails to customers when admins approve the customers' accounts
[Customer] Not Approve Notification: Send notification emails to customers when admins do not approve the customers' accounts
Admin Notification: Send notification emails to admins when customers register accounts that need to be approved
How to configure
1. Configuration
Login to the Admin Magento, choose Stores > Configuration> Customer Approval
.
1.1. General
Enable: Select
Yes
to turn on the Module and use Approve Customer Account functionAuto Approve: If selecting
Yes
, it will automatically Approve when the customer registers on the Frontend.After-registration Notification:
- Enter a notification when the account is successfully registered.
- If left blank, the default is "Your account requires approval".
Not Approve Customer Login: Select the Not Approve Customer Login notification type and still login:
Show Error: Will display the Not Approve Customer Login error message. Displaying additional Error Message field.
- Error Message: Enter the notification when the client account is not accepted or still has not been approved, but try to log in. If left blank, the default is "Your account is not approved".
Redirect CMS Page: Select to redirect to the Not Approve Customer Login page:
For Not Approve Customer Page
Auto Approve via Email Domain:
- Auto Approve condition (automatically approves registrations) based on Email Domain
- Entering Email Domain will activate the function.
- Only registrations with Email Domain entered will be auto-approved.
- All registrations coming from other email domains will be pending and will wait for manual approval by the admin.
Auto Approve via IP Address:
- Auto Approve condition (automatically approves registrations) based on IP Address.
- Entering IP Address will activate the function.
- Only registrations with IP Address entered will be auto-approved.
- All registrations coming from other IP Addresses will be pending and will wait for manual approval by the admin.
Auto Reject By Email Domain:
- Automatically reject registrations based on Email Domain
- Entering the Email Domain will activate the function.
- Only registrations with Email Domain entered will be Auto Rejected
- All registrations coming from other Email Domains are not affected
Auto Reject By IP Address:
- Automatically reject registrations based on Email IP
- Entering the IP Address will activate the function.
- Only registrations with Email IP entered will be Auto Rejected
- All registrations coming from other Email IPs are not affected
- Reject Reason: When enabled, a popup will display with a box to enter the reason for rejection when the admin rejects a customer's registration
1.2. Admin Notification Email
To set the email notification for admin when customers register an account successfully.
- Enable:
- Select "Yes" to turn on email notifications for admin when a customer successfully registers an account. The system will then display other fields.
- Install Mageplaza_SMTP to avoid sending to spam box.
- Admin Notification Email configuration will be collapsed when selecting “No”
- Sender: Select the person to send email to notify admin:
Email Template: Select an email template to notify the admin when the customer successfully registers an account. You can go to
Marketing> Email Templates
, select Add New Template to choose to create a notification email template.Recipient(s): - Enter the email that receives the notification when the customer registers the account.
- You can enter multiple email recipients at the same time, but they must be separated by commas.
1.3. Customer Notification Email
To set the email sending to a customer when an account is registered.
- Sender: Select the person who sent the email to notify the customer.
1.3.1. Successful Register
Enable email notification for customers when they successfully register.
Enable: Select "Yes" to enable email notifications for customers when they successfully register.
Email Template: Choose an email template to notify customers of successful account registration. You can go to
Marketing > Email Templates
and select Add New Template to choose to create a notification email template.
1.3.2. Approve Notification
Enable email notification to customers when approved with a registered account.
Enable: Select "Yes" to enable email notification to customers when approved with a registered account.
Email Template: Choose an email template to notify customers when approved with a registered account. You can go to
Marketing > Email Templates
, select Add New Template to choose to create a notification email template.
1.3.3. Reject Notification
Turn on email notifications for customers when not approved with the registered account.
Enable: Select "Yes" to turn on email notifications for customers when not approved with the registered account.
Email Template: Select an email template to notify customers when a registered account has not been approved. You can go to
Marketing> Email Templates
, select Add New Template to choose to create a notification email template.
2. Customers
This section shows all the information about the registered customers, and the admin can choose to approve or disapprove them.
2.1. Grid
- Login to the Magento Admin, choose
Customers > All Customers
. - This section lists the information of the registered customer with fields such as Name, Email, Group, Approval Status, Date of Birth, etc. Here, you can manually approve or not approve at Action and edit with any customer you want.
2.2. Edit Customer
- Click on
Edit
to edit or approve/not approve any client. With Approval Status shows the status of customer account registration.
Using API
- You can use the API integrated with Magento to view the Approved Customers, Waiting for Approval, and Not Approval Customers when they sign up for an account.
- Here, we use Postman to support this. You can register Postman here. Also, you can use other apps to support approval and not approval.
1. Integration with Magento:
Step 1: Login to the Magento Admin, choose System> Extensions> Integrations> Add New Integrations
to create new integration.
Note: For the API tab you should select Customers and Mageplaza Customer Approval.
Step 2: After creating the Integration, please select Activate
Step 3: Click Allow
to get the information of the Access Token field.
2. Guide for using Postman to get customers list of waiting for approval, approved, and not approved accounts.
2.1 To list the approved customers, you can use the GET method:
- For example:
- Url: http://example.com//rest/V1/customer/id
- For example: http://example.com/rest/V1/customers/1
- With Key and Value: Get the information of the Access Token field that you have just integrated to fill it out below. For example: Authorization: bearer access_token và Content-Type: application/json
- Click Send to get the list of approved customers.
2.2 Approve with customers who have registered an account are in the status of Pending or Not Approval, you can use POST method.
Note
: At the Body part, fill in the email you want to approve. As for the Header section, fill it out the same way as above with the GET method.Example: Url: http://example.com/rest/V1/customer/approve/email
2.3 Not Approve with customers who have registered an account are in Pending or Approval status, you can use POST method.
- Example: Url: http://example.com/rest/V1/customer/not-approve/email
Instructions to run the command to Approve or Not Approve customer accounts
- Approve: You want approval when the registered account is in pending status or not approval, please run the following command:
php bin/magento customer:approve "email customer"
- Example:
php bin/magento customer:approveemail"mageplaza@gmail.com"
- Not Approve:
php bin/magento customer:notapprove"emailcustomer"
- Example:
php bin/magento customer:notapprove"mageplaza@gmail.com"
Note
When installing, you should run the following command to update the customer grid:
php bin/magento indexer:reindex customer_grid
When you want to remove the extension, you should go to the database to delete it. Access to eav_attribute
table, in the attribute_code
column, you find and delete the is_approved
attribute
Support and Assistance
1. Customer Support
For any assistance, please visit our Support page or email us at cs@mageplaza.com/ sales@mageplaza.com
2. Create a Ticket
If you have technical issues, please open a ticket at this link.
3. Operating Hours
Our support team is available during the following hours:
- Monday to Friday: 8:00 AM - 23:59 PM
- Saturday: 8:00 AM - 12:00 PM
- Sunday: Closed
4. Refund Policy
We understand that sometimes things don't go as planned. Please review our refund policy for detailed information: Refund Policy Link
5. Frequently Asked Questions (FAQ)
For common questions, please visit our FAQ page: FAQ Page Link