README

Cake Marketing API, PHP/composer implementation of the Cake Marketing API. (Getcake).

This implementation breaks the Cake Marketing API into individual classes that follow their naming convention.

Cake Marketing API supports Soap 1.1, Soap 1.2, GET and POST. This project uses HTTP GET for each call. Use caution in requesting large data sets, if you are unable to retrieve data because of OOM errors consider using row limiters with row start.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Add the package to your composer impelementation

composer require phpfanatic/cakemarketing

If you are using CakePHP you may need to update the composer.json file of the CakePHP app to have the following for namespacing to work correctly:

 "autoload": {
        "psr-4": {
            "App\\": "src",
            "PhpFanatic\\Cakemarketing\\": "./vendor/phpfanatic/cakemarketing/src"
        }
    },

Requirements

You will need an active Cake Marketing account with an active Api key and domain URL.
PHP - 5.6, 7.0 may work with as early as 5.4, but untested.
cURL
PHPUnit - to run tests (optional).

Example Usage

use PhpFanatic\Cakemarketing\Get;
use PhpFanatic\Cakemarketing\Track;

//Get API
$getApi = new Get('{API_KEY}', '{PORTAL_URL}');
$data = ['lead_id'=>'ID123ABC'];
$xml = $getApi->ApiCall('LeadInfo', $data);

//Track API
$trackApi = new Track('{API_KEY}', '{PORTAL_URL}');
$xml = $trackApi->ApiCall('AcceptedDispositions');

##Documentation The goal is to document features and functionality for this library through our GitHub Wiki for this project. For Cake Marketing API documentation, you should reference their site directly. (Cake Marketing API Documentation)

Built With

Composer - Dependency management
PHPUnit - Testing framework
Packagist - Package repository
Travis CI - Automated building

Authors

Nick White - Initial work - PHPfanatic

License

This project is licensed under the MIT License. This license is limited to the files associated with this project and does not cover nor affiliated with Cake Marketing.

phpfanatic / cakemarketing

Maintainers

Details