oxcom / magento2-currency-services
This is a module that allows to update currency rates from addition external sources.
Package info
github.com/OxCom/magento2-currency-services
Type:magento2-module
pkg:composer/oxcom/magento2-currency-services
Requires
- php: >=7.1
- ext-bcmath: *
- ext-curl: *
- ext-json: *
- ext-simplexml: *
- magento/framework: ^103.0
- magento/module-backend: 100.0.*|100.1.*|100.2.*|101.0.*|102.0.*|103.0.*
- magento/module-config: 100.0.*|100.1.*|101.0.*|101.1.*|101.2.*
- magento/module-directory: 100.0.*|100.1.*|100.2.*|100.3.*|100.4.*
- magento/module-store: 100.0.*|100.1.*|100.2.*|101.0.*|101.1.*
- psr/log: ^1.1|^2.0|^3.0
Requires (Dev)
- dealerdirect/phpcodesniffer-composer-installer: ^1.0
- phpstan/phpstan: ^2.1
- phpunit/phpunit: ^10.5 || ^11.5
- slevomat/coding-standard: ^8.16
- squizlabs/php_codesniffer: ^3.13
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
This is a module that allows to update currency rates from addition external sources.
List of source services
Notes
-
Fixer
[The old, deprecated Fixer API will be discontinued on June 1st, 2018] We are happy to announce the complete relaunch of fixer.io into a more stable, more secure, and much more advanced currency & exchange rate conversion API platform. While the core structure of our API remains unchanged, all users of the legacy Fixer API will be required to sign up for a free API access key and perform a few simple changes to their integration. To learn more about the changes that are required.Be aware that free access to Fixer API has limited functionality.
You can setup Access Token for Fixer API in your administration panel for Magento.
-
Google Finance
Google does not provide a public currency-rates API. This integration parses the requested currency pair from the Google Finance quote page.
Be aware that Google may change its HTML structure at any time.
-
European Central Bank
The reference rates are usually updated around 16:00 CET on every working day, except on TARGET closing days. They are based on a regular daily concertation procedure between central banks across Europe, which normally takes place at 14:15 CET.Be aware about low refresh rate
-
Bank of Canada
The keyless Valet API publishes indicative business-daily rates for selected currencies. Rates are based on Canadian dollars and are normally published by 16:30 ET.
Install
$ composer require oxcom/magento2-currency-services $ bin/magento module:enable OxCom_MagentoCurrencyServices $ bin/magento setup:upgrade $ bin/magento setup:di:compile
CLI commands
Rates can be imported manually per source, without waiting for cron or using the admin panel:
$ bin/magento oxcom:importrates:ecb $ bin/magento oxcom:importrates:fixer $ bin/magento oxcom:importrates:google
Each command fetches rates from the given source and saves them, same as admin System > Currency Rates > Import Now. Non-zero exit code + error output if a rate can't be retrieved.
Commands are registered via DI, so after install run setup:upgrade (and
setup:di:compile in production mode) / flush cache before they show up in
bin/magento list.
Tests
Tests use local fixtures by default, so the regular suite does not require network access:
$ composer install $ vendor/bin/phpunit -c Test/phpunit.xml --no-coverage
Set CURRENCY_SERVICES_LIVE_TESTS=1 and FIXER_FREE_TOKEN to check the live
provider services. GitHub Actions runs that live suite against master every
Monday and Friday at 06:00 UTC.
Composer scripts are available for all checks:
$ composer cs # phpcs (PSR-12 + Slevomat) $ composer stan # phpstan analyse $ composer test # phpunit (no coverage)