n-minten / overheid-api-template
用于创建其他包的样板包。
Requires
- php: >=5.4
Requires (Dev)
- phpunit/phpunit: 5.2.*
This package is auto-updated.
Last update: 2024-09-22 04:17:35 UTC
README
在这个库中,我们使用Overheid.io API来获取KVT数据库中的各种数据,为此我使用了Darwin Biler提供的教程和框架模板,可在此找到:http://www.darwinbiler.com/creating-composer-package-library/
API可在https://api.overheid.io找到,其中包含多个end points,我在这个库中使用了一些。
GET ./openkvk
GET ./openkvk/{id}
GET ./suggest/openkvk/{query}
每个端点都有一个Controller,可以通过它来访问。
KVKIDController.php (GET ./openkvk/{id})
QueryController.php (GET ./openkvk)v
SuggetsController.php (GET ./suggest/openkvk/{query})
QueryController
此Controller用于获取不同KVK注册公司的概览,为此需要一些不同的方法,
$controller->set_api_key("174146f00f414a6b83ed9e750d66203070c0b80355dc34f0235e24d44db2b22e");
此方法将API Key存储在类变量中,以便稍后可以再次检索。
$controller->add_query_item("plaats", "Eindhoven");
此方法设置一个查询项,第一个变量是字段名称,第二个是值,字段名称可以是以下值之一,此功能可以在每个请求中多次执行,但不能包含重复的字段。
$result = $controller->connect();
此方法建立连接并返回一个PHP对象,结果可在"fullresult.md"中找到
可能的字段
- btw
- lei
- rsin
- actief
- bestaandehandelsnaam
- dissiernummer
- handelsnaam
- huisnummer
- pand_id
- plaats
- postcoce
- straat
- subdossiernummer
- type
- vbo_id
- vestigingsnummer
KVK ID Controller
此Controller用于获取公司的特定页面,这样你可以获取比通过Query Controller更多 的信息,但一次只能获取一个公司的信息。
$controller2->set_api_key("174146f00f414a6b83ed9e750d66203070c0b80355dc34f0235e24d44db2b22e");
此方法将API Key存储在类变量中,以便稍后可以再次检索。
$controller2->set_id($_GET['ID']);
此方法设置特定的公司ID。这些ID如下所示,hoofdvestiging-24279396-0000-pyton-communication-services-bv
$controller2->connect();
与Query Controller类中的完全相同,但输出如"CompanyResult.md"中所示
Suggest Controller
此Controller的结果与输入字符串类似的一组结果,对于自动完成输入字段非常有用。
$controller3->set_api_key("174146f00f414a6b83ed9e750d66203070c0b80355dc34f0235e24d44db2b22e");
存储API
$controller3->set_query_string("Auto%20onderhoud");
此字符串用于向用户的搜索查询添加不同的结果
$controller3->set_query(5, "handelsnaam");
此函数允许你访问你接收到的结果数量5
和结果类型handelsnaam
,只能使用两个选项
- handelsnaam
- dossiernummer
$controller2->connect();
与Query Controller类中的完全相同,但输出如"SugestResult.md"中所示