https://github.com/jschwendener/zefix-php
A simple PHP wrapper around the Zefix Public REST API
https://github.com/jschwendener/zefix-php
php zefix
Last synced: 11 months ago
JSON representation
A simple PHP wrapper around the Zefix Public REST API
- Host: GitHub
- URL: https://github.com/jschwendener/zefix-php
- Owner: jschwendener
- License: mit
- Created: 2024-09-09T09:07:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T16:39:41.000Z (almost 2 years ago)
- Last Synced: 2024-09-10T18:42:13.933Z (almost 2 years ago)
- Topics: php, zefix
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Zefix PHP SDK
[](https://github.com/jschwendener/zefix-php/actions/workflows/run-tests.yml)
This is a simple PHP wrapper around the [Zefix](https://www.zefix.admin.ch/de/search/entity/welcome) Public [REST API](https://www.zefix.admin.ch/ZefixPublicREST/swagger-ui/index.html) which can be used to search for swiss companies and retrieve their details.
This package is not affiliated with the Zefix.
## Installation
You can install the package via composer:
```sh
composer require jschwendener/zefix-php
```
## Authentication
A valid username and password is required to access the Zefix API.
You can request access by sending an email to zefix@bj.admin.ch and providing the following information:
- An email address which will be used as username
- Additional email addresses which should receive information maintenance and updates of the API
## Usage
### Search for companies
Search for companies registered in the commercial register by different parameters
```php
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,
]);
```
### Get company details
Get detailed company info by UID
```php
use Jschwendener\Zefix\Zefix;
$zefix = new Jschwendener\Zefix\Zefix('username', 'password');
$details = $zefix->company()->getByUid('CHE-123.456.789');
```
## Credits
This SDK is built using [Saloon PHP](https://docs.saloon.dev/).
---
The Zefix PHP SDK is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).