ecomailcz / flexibee-client
ECOMAIL.CZ - 用于与FlexiBee API通信的简单客户端
1.4
2022-02-16 12:48 UTC
Requires
- php: ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- ext-simplexml: *
- ecomailcz/purl: ^2.0
- league/flysystem: ^3.0
- rakit/validation: ^1.1
- slevomat/consistence: ^2.1
Requires (Dev)
- brianium/paratest: ^6.0
- ergebnis/composer-normalize: ^2.5
- fzaninotto/faker: ^1.7
- mockery/mockery: ^1.3
- phing/phing: ^2.16
- php-parallel-lint/php-parallel-lint: ^1.2
- phpstan/extension-installer: ^1.0
- phpstan/phpstan: ^1.0
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpstan/phpstan-strict-rules: ^1.0
- phpunit/phpunit: ^9.0
- slevomat/coding-standard: ^6.0 || ^7.0
This package is auto-updated.
Last update: 2024-08-29 13:11:00 UTC
README
一个简单的cURL客户端,负责向Flexibee系统发送正确的请求,并返回结果。
赞助商
通过composer安装
composer require ecomailcz/flexibee-client
实现
$client = new Client(
$accountUrl,
$companyCode,
$restApiUserName,
$restApiPassword,
$evidenceName,
$disableSelfSignedCertificate,
$authSessionId,
);
$disableSelfSignedCertificate - 关闭自签名证书
$authSessionId - FlexiBee认证ID的值
生成授权令牌
$client = new Client('https://demo.flexibee.eu', 'demo', 'winstrom', 'winstrom', 'adresar', false, null);
$tokens = $client->getAuthAndRefreshToken();
公司或公司信息
$client = new Client('https://demo.flexibee.eu', 'demo', 'winstrom', 'winstrom', 'adresar', false, null);
$companies = $client->getCompanies();
$company = $client->getCompany();
创建或编辑记录
$client = new Client('https://demo.flexibee.eu', 'demo', 'winstrom', 'winstrom', 'adresar', false, null);
$evidenceData['kod'] = 'prvnizaznam'
$evidenceData['nazev'] = 'První kontaktní adresa'
$evidenceItemId = $client->save($evidenceData, null, $dryRun, $uriParameters);
如果一切顺利,将返回包含FlexiBee系统数据的$id
。
根据参数返回记录
根据id查找记录,如果记录不存在则抛出异常
$evidenceItem = $client->getById($evidenceItemId, $uriParameters);
$evidenceItem = $client->getByCode($evidenceItemCode, $uriParameters);
如果FlexiBee中不存在则返回空记录(不抛出异常)
$evidenceItem = $client->findById($evidenceItemId, $uriParameters);
$evidenceItem = $client->findByCode($evidenceItemCode, $uriParameters);
$evidenceItem = $client->findLastInEvidence($evidenceItemCode, $uriParameters);
求和
$client->sumInEvidence();
删除记录
$client->deleteById($id, $dryRun);
$client->deleteByCode($code, $dryRun);
生成PDF
FlexiBee系统允许返回生成的发票。
$client->getPdfById($id, $uriParameters);
在记录中搜索
FlexiBee系统允许在记录中搜索。(https://www.flexibee.eu/api/dokumentace/ref/filters/)
$client->searchInEvidence($query, $uriParameters);
带分页的记录搜索
FlexiBee系统允许在记录中搜索。(https://www.flexibee.eu/api/dokumentace/ref/filters/)URI参数会自动分配参数'add-row-count' => 'true'
。返回包含数据和记录总数的数组。
$client->searchInEvidencePaginated($query, $uriParameters);
记录列表
特定记录的所有可用元素列表
$client->getPropertiesForEvidence();
创建自己的请求
客户端提供创建自定义请求的选项。只需调用
$responseData = $client->callRequest(Method $httpMethod, string $section, array $queryParameters);
之后,您将有权访问FlexiBee返回的数据。错误通过抛出特定异常来处理。