dreamcampaigns/managesend-bundle

DreamCampaigns API integration for your Symfony project

v2.0.1 2020-07-08 15:35 UTC

This package is auto-updated.

Last update: 2024-09-14 05:21:52 UTC


README

Travis (.org) Packagist Packagist Version Packagist

This bundle integrates DreamCampaigns API into your Symfony application.

Prerequisites

This version of the bundle requires Symfony 5 for Symfony 2, 3 or 4 versions try v1.

Installation

managesend-bundle is available on Packagist as the dreamcampaigns/managesend-bundle package.

Symfony 2.7 and 3 (using Composer)

Require the bundle in your composer.json file:

{
    "require": {
        "dreamcampaigns/managesend-bundle": "*"
    }
}

Install the bundle:

$ composer require dreamcampaigns/managesend-bundle

Register the bundle:

// app/AppKernel.php

public function registerBundles()
{
    return array(
        new Managesend\ApiBundle\ManagesendApiBundle(),
        // ...
    );
}

Configuration in Symfony 2.7 and 3

Add DreamCampaigns Api keys

#app/config/config.yml

managesend_api:
    api_key: <Your API Token Key>
    api_secret: <Your API Token Secret>
    client_id: <Your Client id> #optional for some calls
    timeout: 60 #optional timeout value, default is 60 secs

Configuration in Symfony 4 and up

Add DreamCampaigns Api keys

You can add your Api keys to the managesend_api.yaml

# config/packages/managesend_api.yaml

managesend_api:
    api_key: <Your API Token Key>
    api_secret: <Your API Token Secret>
    client_id: <Your Client id> #optional for some calls
    timeout: 60 #optional timeout value, default is 60 secs

or use the .env

MANAGESEND_TOKEN_KEY=ACXXXXXX
MANAGESEND_TOKEN_SECRET=YXYXYX
MANAGESEND_CLIENT_ID=c5is8tltkk00018k9ype5lg741

Usage

The API is available with the managesend_api service. To access it, get it from controller container:

<?php
$managesend = $this->get('managesend_api');

Or use DependencyInjection

public function TestAction(\Managesend\RestClient $managesend)
{
   $result = $managesend->clients()->getClients();
}

Examples

Samples for accessing all resources can be found in the examples directory of dreamcampaigns/managesend-php

Documentation

For more details you can reffer to the DreamCampaigns API documentations