README

Our APIs provide programmatic access to your Stannp Bulk Mailer account. Things like configuring campaigns, feeding data and triggering mail pieces to be dispatched can all be achieved using simple yet secure HTTP requests. This SDK aims to provide a way to easily integrate our API into your app

More information regarding parameters and API options can be found within the Stannp API documentation here.

Setup

best installed via composer

composer update stannp\stannpphp

The autoloader must be required

require_once  'YOUR/PROJECT/ROOT/vendor/autoload.php';

The API key must either be passed as a parameter at the instantiation of the object or set as a constant within your application. This will not work without a valid API key

Example:

define("STANNP_API_KEY", "API_KEY_HERE");
or
$user = new User("API_KEY_HERE");

You can find your api key at the bottom of your Stannp settings page.

Usage

As with the API the SDK is broken down into the separate components. The naming scheme for the classes and methods matches with the API docs; A complete list of these classes are:

use Stannp\API\Campaigns;
use Stannp\API\Groups;
use Stannp\API\Letters;
use Stannp\API\Postcard;
use Stannp\API\Recipients;
use Stannp\API\Reporting;
use Stannp\API\User;

Usage examples:

use Stannp\API\Postcard;

$user = new User();
$user->getMe();

use Stannp\API\Postcard

$postcard = new Postcard();
$postcard->create(
	"A6",
	"https://www.stannp.com/assets/samples/a6-postcard-front.jpg",
	"Hello World",
	"Signature goes here",
	"Mr",
	"John",
	"Smith",
	"123 Fakestreet",
	"Address ln 2",
	"Cityshire",
	"AB12 3CD",
	 true,
	"GB"
);

Output

All output is in JSON format, to convert to a PHP object use json_decode()