tilleuls / ymlp-bundle
Integrates YMLP API for Symfony
Installs: 3 581
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 24
Forks: 1
Open Issues: 0
Type:symfony-bundle
Requires
- php: >=5.4
- guzzlehttp/guzzle: ^4.0
- symfony/config: ^2.3 || ^3.0
- symfony/dependency-injection: ^2.3 || ^3.0
- symfony/http-kernel: ^2.3 || ^3.0
Requires (Dev)
- phpspec/phpspec: ^2.0
This package is auto-updated.
Last update: 2024-10-27 02:49:15 UTC
README
This bundle integrates the Your Mailing List Provider (YMLP) API into Symfony projects.
Installation
Use Composer to install this bundle:
composer require tilleuls/ymlp-bundle
Add the bundle in your application kernel:
// app/AppKernel.php public function registerBundles() { return [ // ... new CoopTilleuls\Bundle\YmlpBundle\CoopTilleulsYmlpBundle(), // ... ]; }
Configuration
# app/config/config.yml coop_tilleuls_ymlp: # YMLP URL for API calls (default to https://www.ymlp.com/api/) api_url: https://www.ymlp.com/api/ # Your YMLP API key (no default) api_key: YOURSECRETAPIKEY1234 # Your YMLP username (no default) api_username: tilleuls
Usage
use CoopTilleuls\Bundle\YmlpBundle\Ymlp\Exception\YmlpException; // Get an instance of the YMLP API client as a service $ymlpClient = $this->get('coop_tilleuls_ymlp.client'); // Call the simple Ping() command of the YMLP API $pingResponse = $ymlpClient->call('Ping'); // Add a new contact to one or more groups with exception handling try { $contactsAddResponse = $ymlpClient->call('Contacts.Add', ['Email' => 'baptiste@les-tilleuls.coop', 'GroupID' => 1]); } catch (YmlpException $e) { //... }
The call()
method returns an array containing the response or throws an exception of type \CoopTilleuls\Bundle\YmlpBundle\Ymlp\Exception\YmlpException
.
You can obtain a list of all the commands of the API, their parameters and their responses on the YMLP API page (require YMLP credentials).
Credits
This bundle has been written by Baptiste Meyer for Les-Tilleuls.coop.