werkspot/kvk-api

PHP KVK API客户端

v0.1.3 2020-12-15 09:46 UTC

This package is auto-updated.

Last update: 2024-09-16 17:11:48 UTC


README

此包为您的PHP项目提供了一个简单的官方KVK Api集成。

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version License

安装

使用composer,添加

$ composer require werkspot/kvk-api

根证书

2020年10月28日,KVK开始使用荷兰政府签发的自签名证书签名SSL连接。为了防止此包破坏现有实现,SSL验证默认禁用。如果您想启用SSL证书的验证,可以将证书路径(包括)作为工厂的第三个参数实现。如果未这样做,将触发弃用错误(E_USER_DEPRECATED)。

使用方法

配置文件查询

use Werkspot\KvkApi\Http\Endpoint\Production;
use Werkspot\KvkApi\Http\Search\ProfileQuery;
use Werkspot\KvkApi\KvkClientFactory;

$client = KvkClientFactory::create('<YOUR_API_KEY>', new Production(), '/path/to/dutch-government-certificate.pem');

$profileQuery = new ProfileQuery();
$profileQuery->setKvkNumber('18079951');

$kvkPaginator = $client->getProfile($profileQuery);

foreach ($kvkPaginator->getItems() as $company) {
    // {your code}
}

// get next set of data
$kvkPaginator = $client->getNextPage($kvkPaginator);

搜索查询

use Werkspot\KvkApi\Http\Endpoint\Production;
use Werkspot\KvkApi\Http\Search\SearchQuery;
use Werkspot\KvkApi\KvkClientFactory;

$client = KvkClientFactory::create('<YOUR_API_KEY>', new Production());


$searchQuery = new SearchQuery();
$searchQuery->setStreet('ABEBE Bikilalaan');
$kvkPaginator = $client->fetchSearch($searchQuery);

// get next set of data
$kvkPaginator = $client->getNextPage($kvkPaginator);

测试

要运行测试,您可以使用项目根目录中的make命令。

$ make test-cs
$ make test-unit
$ make test-integration

您还可以使用以下命令自动修复编码规范

$ make fix-cs

作者

KVK API由LauLaman创建,目前由Werkspot的开发者维护。