jschwendener/zefix-php

瑞士 Zefix REST API 的 PHP SDK

v0.0.3 2024-09-10 16:39 UTC

This package is auto-updated.

Last update: 2024-09-10 16:39:43 UTC


README

Run Pest tests

这是一个简单的 PHP 包装器,围绕 Zefix 公共 REST API,可以用于搜索瑞士公司和检索其详细信息。此软件包与 Zefix 无关。

安装

您可以通过 composer 安装此软件包

composer require jschwendener/zefix-php

身份验证

要访问 Zefix API,需要有效的用户名和密码。

您可以通过发送电子邮件到 zefix@bj.admin.ch 并提供以下信息来请求访问

  • 将用作用户名的电子邮件地址
  • 应该接收信息维护和 API 更新的附加电子邮件地址

用法

搜索公司

通过不同参数搜索注册在商业登记处的公司

use Jschwendener\Zefix\Zefix;

$zefix = new Jschwendener\Zefix\Zefix('username', 'password');

// Search for companies by name
$results = $zefix->company()->search('company name');

// Search for companies by name and additional parameters
$results = $zefix->company()->search('company name', [
    'canton' => 'ZH',
    'activeOnly' => false,
]);

获取公司详细信息

通过 UID 获取详细的公司信息

use Jschwendener\Zefix\Zefix;

$zefix = new Jschwendener\Zefix\Zefix('username', 'password');

$details = $zefix->company()->getByUid('CHE-123.456.789');

致谢

此 SDK 是使用 Saloon PHP 构建的。

Zefix PHP SDK 是开源软件,许可协议为 MIT 许可证