asisteam / adol
ADOL API端点的通信实现
Requires
- php: >= 7.1
- ext-json: *
- guzzlehttp/guzzle: ^6.3
- nette/di: ^2.4
Requires (Dev)
- mockery/mockery: ^1.2
- ninjify/nunjuck: ^0.2.0
- ninjify/qa: ^0.8.0
This package is auto-updated.
Last update: 2024-09-26 09:57:22 UTC
README
致谢
开发由AsisTeam s.r.o.进行。欢迎使用和贡献。
安装
composer require asisteam/adol
版本
概述
此包与以下ADOL API进行通信
注意:为了与ADOL API通信,您必须拥有自己的私有token
字符串。此token
由ADOL提供。
基本原理
对于每个提供的API,将创建一个单独的客户端类(请参阅Client/WatchDog/...
,Client/Property/...
)。为了创建客户端,您必须通过将其构造函数传递至少一个有效的token
字符串来实例化它。或者,您可以替换默认的GuzzleHttp客户端,使用您自己的实现ClientInterface的自定义http客户端。如果使用GuzzleHttp客户端,您还可以传递一个第三个可选的构造函数参数,即一个请求选项数组,该数组将被附加到由http客户端发出的每个请求上。通过使用此选项数组,您可以设置客户端超时等所有客户端调用的设置。请参阅http://docs.guzzlephp.org/en/stable/request-options.html上的可用Guzzle选项。
进行调用时,可能会抛出两个异常。
- 如果请求无效,将抛出
RequestException
。请求将不会执行。 - 当请求已发送且ADOL服务器的响应包含无效状态或缺少某些数据时,将抛出
ResponseException
。
如何运行测试和检查代码
代码质量保证:composer qa
PHPSTAN: composer phpstan
单元和集成测试:composer tests
注意:由于您将支付对真实API执行的每个请求的费用,因此默认情况下会跳过集成测试。要运行集成测试,请编辑tests/Cases/Integration/AbstractTestCase
并填写您的私有token
,并在setUp()方法中删除Environment::skip
行。
Nette桥
您可以将客户端配置为Nette框架DI服务,您将能够使用以下服务
看门狗API
- adol.watchdog.insolvency
- adol.watchdog.property
地产API
- adol.property.land
- adol.property.building
- adol.property.building_unit
- adol.property.person
extensions:
adol: AsisTeam\ADOL\Bridges\Nette\DI\AdolExtension
adol:
token: "your dedicated adol token"
options: [
timeout: 20
]