elgentos / magento2-openkvk

elgentos/magento2-openkvk

Extension to load KVK (Dutch Chamber of Commerce) data into Magento

  • elgentos
magento2-module Compatibility: Not yet tested Code Quality: Fail Tests: N/A Security: Pass proprietary

OpenKvk Magento 2 Implementation

This integration makes it possible to fetch OpenKvk data for Dutch companies
into your Magento project. Using an API key from Overheid.io
you can fetch the company data based on KVK number (Chamber of Commerce) or by
postcode and house number.

Note: The basic implementation for this project is based on Hyva
and will not work with Magento's Luma or Blank theme at this moment. This can
be added in the future.

Installation

This package can be installed using Composer with the following command.

composer require elgentos/magento2-openkvk
bin/magento2 setup:upgrade

Usage

To use this package, you need to get an API key from Overheid.io
and you need to configure the extension in Stores > Configuration > Customer
Configuration > OpenKvk
.

Also, to display this in the account pages, make sure you add this line to the
file app/design/frontend/[Namespace]/[Theme]/Magento_Customer/templates/address/form.phtml:

<?= $block->getChildHtml('openkvk_js'); ?>

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

Unreleased

Added

  • Support for fetching company data from Overheid.io
  • AJAX controller to fetch the data within a webpage (i.e. customer page)
  • GraphQL support to fetch the data using GraphQL
Versions
Version Stability QA Status Compatibility Released
1.0.1 stable Pass Not yet tested Details 2021-03-22 12:21:06
1.0.0 stable Not tested Not yet tested Details 2021-03-12 13:36:22

Requires 5

Package Constraint
magento/framework ^103.0
magento/module-customer ^103.0
magento/module-eav ^102.1
magento/module-store ^101.1
webonyx/graphql-php ^0.13.8

Requires-dev 2

Package Constraint
mediact/testing-suite @stable
mediact/coding-standard-magento2 @stable

Compatibility

Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 not tested not tested
2.4.8 not tested not tested
2.4.9 not tested not tested

Code Quality

Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.

Static analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

Static analysis results
Tool Status Findings Summary
PHPCS Warning 4 4 warnings (ruleset: Magento2) — 1 auto-fixable with phpcbf
PHPMD Warning 4 4 rule violations (UnusedFormalParameter:4)
Cpd Pass 0
Composer validate Pass 0

PHPStan

Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Error Error
2.4.8 Error Error
2.4.9 Error Error

Tests

Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.

Unit tests

Unit tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Integration tests

Integration tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Security

Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.

Security results
Tool Status Findings Summary
Composer audit N/A 0 no resolvable dependency tree to audit — Your requirements could not be resolved to an installable set of packages. Problem 1
Malware scan Pass 0
License
proprietary
Authors

More from elgentos

View vendor
Make it pay

Turn an existing module into recurring revenue.

If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.