Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codewithdennis/chamber-of-commerce
A Laravel wrapper tailored for simplifying and enhancing interactions with the Chamber of Commerce API from The Netherlands.
https://github.com/codewithdennis/chamber-of-commerce
api chamber-of-commerce kamer-van-koophandel laravel php wrapper
Last synced: about 1 month ago
JSON representation
A Laravel wrapper tailored for simplifying and enhancing interactions with the Chamber of Commerce API from The Netherlands.
- Host: GitHub
- URL: https://github.com/codewithdennis/chamber-of-commerce
- Owner: CodeWithDennis
- License: mit
- Created: 2023-10-05T20:37:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-26T14:51:16.000Z (12 months ago)
- Last Synced: 2024-03-28T09:20:58.922Z (8 months ago)
- Topics: api, chamber-of-commerce, kamer-van-koophandel, laravel, php, wrapper
- Language: PHP
- Homepage:
- Size: 39.1 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Chamber Of Commerce API
[](https://packagist.org/packages/codewithdennis/chamber-of-commerce)
[](https://packagist.org/packages/codewithdennis/chamber-of-commerce)
This Kamer van Koophandel (Chamber of Commerce) API wrapper enables seamless interaction with the Kamer van Koophandel (Chamber of Commerce) API, enabling you to access information about businesses and organizations registered in the Netherlands. For comprehensive details, please visit the official Kamer van Koophandel website.
## Installation
You can install the package via composer:
```bash
composer require codewithdennis/chamber-of-commerce
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="chamber-of-commerce-config"
```
This is the contents of the published config file:
```php
return [
'key' => env('COC_API_KEY'),
'test_key' => env('COC_API_TEST_KEY'),
'test_enabled' => env('COC_API_TEST_ENABLED', false)
];
```
## How to Use
Add your API key to the `.env` file
```dotenv
COC_API_KEY=
COC_API_TEST_KEY="l7xx1f2691f2520d487b902f4e0b57a0b197"
```
Create an instance of the ChamberOfCommerce class to start making API requests:
```php
use CodeWithDennis\ChamberOfCommerce\ChamberOfCommerce;
$chamberOfCommerce = new ChamberOfCommerce();
```
### Use the search function
Search by KvK number
```php
$chamberOfCommerce->number('12345678');
```
Search by business name number
```php
$chamberOfCommerce->name('IKEA');
```
Search by RSIN number
```php
$chamberOfCommerce->rsin('123456789');
```
Include inactive companies in the search results.
```php
$chamberOfCommerce->withInactiveCompanies(true);
```
Search by branche number
```php
$chamberOfCommerce->branchNumber('B1234');
```
Search by street name
```php
$chamberOfCommerce->streetName('Hullenbergweg');
```
Search by postal code (In combination with house number)
```php
$chamberOfCommerce->postalCode('1234 AB');
```
Search by house number (requires postal code)
```php
$chamberOfCommerce->houseNumber(2);
```
Search by house number addition
```php
$chamberOfCommerce->houseNumberAddition('A');
```
Search by location (city, place)
```PHP
$chamberOfCommerce->location('Amsterdam');
```
Search by business type
```php
// Options: hoofdvestiging (main office), nevenvestiging (branch office), rechtspersoon (legal entity)
$chamberOfCommerce->type('hoofdvestiging');
```
Set the page number for pagination (you can use this to iterate through pages)
```php
$chamberOfCommerce->page(1);
```
Set the number of results per page.
```php
$chamberOfCommerce->pagination(10);
```
After chaining your methods, you can initiate the API request by invoking the "search" function like so:
```php
$response = $chamberOfCommerce
->name('IKEA')
->location('Amsterdam')
->pagination(5)
->search();
```
### [Basic profiles](https://developers.kvk.nl/documentation/basisprofiel-api)
To fetch basic profiles for a particular KvK (Chamber of Commerce) number, you can use the following code:
```php
$response = $chamberOfCommerce
->withGeo()
->number(33143768)
->profiles();
```
### [Test environment](https://developers.kvk.nl/documentation/testing)
To utilize the testing environment, simply enable it in your `.env` file:
```bash
COC_API_TEST_ENABLED=true
```
Ensure that you include the following key in your `.env` file:
```bash
COC_API_TEST_KEY="l7xx1f2691f2520d487b902f4e0b57a0b197"
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [CodeWithDennis](https://github.com/CodeWithDennis)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.