Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phobetor/billomat-bundle
A Symfony 2 bundle around the billomat API client
https://github.com/phobetor/billomat-bundle
Last synced: 20 days ago
JSON representation
A Symfony 2 bundle around the billomat API client
- Host: GitHub
- URL: https://github.com/phobetor/billomat-bundle
- Owner: Phobetor
- License: mit
- Created: 2014-02-16T17:35:32.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-09-08T20:07:32.000Z (over 10 years ago)
- Last Synced: 2024-11-11T06:44:34.149Z (2 months ago)
- Language: PHP
- Size: 262 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Billomat API Client Bundle for Symfony 2
===============
[](https://packagist.org/packages/phobetor/billomat-bundle) [](https://packagist.org/packages/phobetor/billomat-bundle)
A Symfony 2 bundle for the [Billomat API client](https://github.com/Phobetor/billomat).
## Installation
Add bundle via command line
```sh
php composer.phar require phobetor/billomat-bundle
```
or manually to `composer.json` file
```js
{
"require": {
"phobetor/billomat-bundle": "~1.3"
}
}
```
Fetch the needed files:
```bash
$ php composer.phar update phobetor/billomat-bundle
```
This will install the bundle and the client to your project’s `vendor` directory.
Add the bundle to your project’s `AppKernel`:
```php
get('phobetor_billomat')->getClient();
```
## Automatic rate limit handling
If this client is used in asynchronous processes or CLI commands you can activate automatic waiting for rate limit reset.
In that mode all method calls that would otherwise throw a `\Phobetor\Billomat\Exception\TooManyRequestsException` will wait for the rate limit reset and retry automatically.
You SHOULD NOT use this in synchronous request (e. g. a website request) because all method calls in that mode can last very long and most likely longer than your server’s gateway timeout.
There are two ways to do this.
In configuration:
```yml
# app/config/config.yml
phobetor_billomat:
# […]
wait_for_rate_limit_reset: true
```
After fetching from container:
```php
$billomat = $this->get('phobetor_billomat')->getClient();
$billomat->setDoWaitForRateLimitReset(true);
```
## Multiple configurations
You can add multiple configurations to your `app/config/config.yml`. This allows you to configure multiple users, apps or combinations.
```yml
# app/config/config.yml
phobetor_billomat:
id: 'my-id'
api_key: 'my-key'
clients:
cli:
id: 'my-id'
api_key: 'my-key'
application:
id: 'my-app-id'
secret: 'my-app-secret'
wait_for_rate_limit_reset: true
```
This example configures the default client without an app (which grants requests up to the standard user rate limit of 300 requests) and without automatic rate limit handling.
In addition another `cli` client is configured with an app (which grants requests up to the standard app rate limit of 1000 requests) and with automatic rate limit handling.
In that way you can use a client with automatic rate limit handling in you asynchronous (and most likely long running) cli commands:
```php
$billomat = $this->get('phobetor_billomat')->getClient('cli');
// e. g. create a huge bunch of invoices
```
In parallel, you can use a client without a configured app (which gives you a lower, but separate rate limit) to use in your application’s requests:
```php
$billomat = $this->get('phobetor_billomat')->getClient();
// e. g. fetch and show a list of invoices in your internal application
```