# Mage2 Module Ktpl Zinrelo
``ktpl/module-zinrelo``
- [Main Functionalities](#markdown-header-main-functionalities)
- [Installation](#markdown-header-installation)
- [Configuration](#markdown-header-configuration)
- [Specifications](#markdown-header-specifications)
- [Attributes](#markdown-header-attributes)
## Main Functionalities
This module helps to integrate zinrelo into magento
## Installation
\* = in production please use the `--keep-generated` option
### Type 1: Zip file
- Unzip the zip file in `app/code/Ktpl`
- Enable the module by running `php bin/magento module:enable Ktpl_Zinrelo`
- Apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
### Type 2: Composer
- Make the module available in a composer repository for example:
- private repository `repo.magento.com`
- public repository `packagist.org`
- public github repository as vcs
- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
- Install the module composer by running `composer require ktpl/module-zinrelo`
- enable the module by running `php bin/magento module:enable Ktpl_Zinrelo`
- apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
## Configuration
- Enabled (zinrelo/credentials/is_enabled)
- Partner ID (zinrelo/credentials/partner_id)
- API Key (zinrelo/credentials/api_key)
- Store Base URL (zinrelo/credentials/store_base_url)
- Eligible Rewards for Customer (zinrelo/urls/get_eligible_rewards_for_customer)
- Redeem Points (zinrelo/urls/redeem_point_with_status_pending)
- Approve Points (zinrelo/urls/approve_point)
- Award Points (zinrelo/urls/award_points)
- Return Points (zinrelo/urls/return_point)
- Reject points (zinrelo/urls/reject_points)
- Create a Loyalty Member (zinrelo/urls/create_loyalty_member)
- Update Loyalty Member (zinrelo/urls/update_loyalty_member)
## Specifications
- Block
- CustomerBanners > customerbanners.phtml
- Cronjob
- ktpl_zinrelo_customersync
- Cronjob
- ktpl_zinrelo_customerupdate
- Helper
- Ktpl\Zinrelo\Helper\APIHelper
- Helper
- Ktpl\Zinrelo\Helper\Data
- Observer
- customer_register_success > Ktpl\Zinrelo\Observer\Frontend\Customer\RegisterSuccess
- Observer
- customer_account_edited > Ktpl\Zinrelo\Observer\Frontend\Customer\AccountEdited
- Observer
- sales_order_place_after > Ktpl\Zinrelo\Observer\Sales\OrderPlaceAfter
- ViewModel
- Ktpl\Zinrelo\ViewModel\CustomerBanners
## Attributes
- Customer - Synced With Zinrelo (zinrelo_is_sync)
- Customer - Synced With Zinrelo Date (zinrelo_sync_date)
- Product - Item Disc Group (erp_item_desc_group)
- Sales - Zinrelo Reward Id (zinrelo_reward_id)
``ktpl/module-zinrelo``
- [Main Functionalities](#markdown-header-main-functionalities)
- [Installation](#markdown-header-installation)
- [Configuration](#markdown-header-configuration)
- [Specifications](#markdown-header-specifications)
- [Attributes](#markdown-header-attributes)
## Main Functionalities
This module helps to integrate zinrelo into magento
## Installation
\* = in production please use the `--keep-generated` option
### Type 1: Zip file
- Unzip the zip file in `app/code/Ktpl`
- Enable the module by running `php bin/magento module:enable Ktpl_Zinrelo`
- Apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
### Type 2: Composer
- Make the module available in a composer repository for example:
- private repository `repo.magento.com`
- public repository `packagist.org`
- public github repository as vcs
- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
- Install the module composer by running `composer require ktpl/module-zinrelo`
- enable the module by running `php bin/magento module:enable Ktpl_Zinrelo`
- apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
## Configuration
- Enabled (zinrelo/credentials/is_enabled)
- Partner ID (zinrelo/credentials/partner_id)
- API Key (zinrelo/credentials/api_key)
- Store Base URL (zinrelo/credentials/store_base_url)
- Eligible Rewards for Customer (zinrelo/urls/get_eligible_rewards_for_customer)
- Redeem Points (zinrelo/urls/redeem_point_with_status_pending)
- Approve Points (zinrelo/urls/approve_point)
- Award Points (zinrelo/urls/award_points)
- Return Points (zinrelo/urls/return_point)
- Reject points (zinrelo/urls/reject_points)
- Create a Loyalty Member (zinrelo/urls/create_loyalty_member)
- Update Loyalty Member (zinrelo/urls/update_loyalty_member)
## Specifications
- Block
- CustomerBanners > customerbanners.phtml
- Cronjob
- ktpl_zinrelo_customersync
- Cronjob
- ktpl_zinrelo_customerupdate
- Helper
- Ktpl\Zinrelo\Helper\APIHelper
- Helper
- Ktpl\Zinrelo\Helper\Data
- Observer
- customer_register_success > Ktpl\Zinrelo\Observer\Frontend\Customer\RegisterSuccess
- Observer
- customer_account_edited > Ktpl\Zinrelo\Observer\Frontend\Customer\AccountEdited
- Observer
- sales_order_place_after > Ktpl\Zinrelo\Observer\Sales\OrderPlaceAfter
- ViewModel
- Ktpl\Zinrelo\ViewModel\CustomerBanners
## Attributes
- Customer - Synced With Zinrelo (zinrelo_is_sync)
- Customer - Synced With Zinrelo Date (zinrelo_sync_date)
- Product - Item Disc Group (erp_item_desc_group)
- Sales - Zinrelo Reward Id (zinrelo_reward_id)
Platform Compability | Open Source |
---|