Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plotkabytes/redlink-api-bundle
Redlink PHP API client wrapped into Symfony Bundle!
https://github.com/plotkabytes/redlink-api-bundle
api bundle emaillabs redlink rest symfony vercom
Last synced: 25 days ago
JSON representation
Redlink PHP API client wrapped into Symfony Bundle!
- Host: GitHub
- URL: https://github.com/plotkabytes/redlink-api-bundle
- Owner: plotkabytes
- License: mit
- Created: 2022-04-27T09:41:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-20T13:34:24.000Z (over 2 years ago)
- Last Synced: 2024-11-19T04:28:38.603Z (about 2 months ago)
- Topics: api, bundle, emaillabs, redlink, rest, symfony, vercom
- Language: PHP
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Redlink API Symfony Bundle
[](https://github.com/plotkabytes/redlink-api-php-client/blob/main/LICENSE)
[](http://makeapullrequest.com)
This repository contains simple symfony bundle for [redlink-api-php-client](https://github.com/plotkabytes/redlink-api-php-client).
## Requirements
This version supports [PHP](https://php.net) >= 7.2 and [Symfony](https://symfony.com/) >= 4.4.0.
## Installation
Make sure Composer is installed globally, as explained in the
[installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
### Applications that use Symfony Flex
After getting composer you have to install PSR HTTP client implementation (if you dont have one already -
for example [Guzzle](https://github.com/guzzle/guzzle) / [Buzz](https://github.com/kriswallsmith/Buzz)):
```console
$ composer require guzzlehttp/guzzle
```
Next you should install this package with usage of composer:
```console
$ composer require --no-scripts plotkabytes/redlink-api-php-client plotkabytes/redlink-api-symfony-bundle
```
### Applications that don't use Symfony Flex
#### Step 1: Download the Bundle
Procedure is the same as in "Applications that use Symfony Flex" chapter.
### Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the `config/bundles.php` file of your project:
```php
// config/bundles.php
return [
// ...
Plotkabytes\RedlinkApiBundle\PlotkabytesRedlinkApiBundle.php::class => ['all' => true],
];
```
### Step 3: Configure the Bundle
Then, configure the bundle by adding following configuration to the `config/packages/plotkabytes_redlink_api.yaml` file:
```yml
# config/packages/plotkabytes_redlink_api.yaml
plotkabytes_redlink_api:
clients:
client_name:
authorization_key: HERE_INSERT_AUTHORIZATION_KEY
application_key: HERE_INSERT_APPLICATION_KEY
alias: OPTIONAL_CLIENT_ALIAS
default: false
```
### Step 4: Clear cache
After bundle configuration may be required to clear symfony cache.
```console
$ bin/console cache:clear
```
### Step 5: Register service
Inside `config/services.yaml` add following:
```yml
# config/services.yaml
services:
# ...
# Other services
# ...
App\Controller\DefaultController:
arguments: {$client: '@plotkabytes_redlink_api.client.default'}
```
### Step 6: Use bundle
```php
client = $client;
}
}
```
## Versioning
We use [Semantic Versioning 2.0.0](https://semver.org/).
Given a version number MAJOR.MINOR.PATCH, increment the:
* MAJOR version when you make incompatible API changes,
* MINOR version when you add functionality in a backwards compatible manner, and
* PATCH version when you make backwards compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
## Contributing
We will gladly receive issue reports and review and accept pull requests.
Feel free to contribute in any way.
## Author
Mateusz Żyła
## License
Redlink Api Symfony Bundle is licensed under [The MIT License (MIT)](LICENSE).