README

This is basic PHP wrapper around the Email Brilliance Marketing API - (https://app.emailmarketingbrilliance.co.uk/help/api_integration)

Installation

You can install the package via composer:

composer require clockworkmarketing/email-marketing-brilliance-php-api

API Keys

The first step to getting started with the API is to generate API keys. Admin rights are required to perform this action within the account settings screen. Once API keys have been generated, HTTP GET and POST requests can be made to all API endpoints.

Usage

<?php

use ClockworkMarketing\EmailMarketingBrilliance\EmailMarketingBrilliance;

$response = $emb = EmailMarketingBrilliance::setAuthDetails('API_ID', 'API_KEY')
    ->call(
        'GET',
        '/users/details', 
        ['email_address'=>'example@example.com']
    );

// OR // 

$emb = new EmailMarketingBrilliance('API_ID', 'API_KEY');

$response = $emb->call(
    'GET',
    '/users/details', 
    ['email_address'=>'example@example.com']
);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email support@clock-work.co.uk instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

clockworkmarketing / email-marketing-brilliance-php-api

Maintainers

Details