A PHP module to send physical mail with the Seeuletter.com API.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src/Seeuletter
.gitignore
LICENSE
README.md
composer.json

README.md

seeuletter-php

Packagist version Dependency Status

Seeuletter.com PHP Client is a simple but flexible wrapper for the Seeuletter.com API. See full Seeuletter.com documentation here. For best results, be sure that you're using the latest version of the Seeuletter API and the latest version of the PHP wrapper.

Table of Contents

Getting Started

Here's a general overview of the Seeuletter services available, click through to read more.

Please read through the official API Documentation to get a complete sense of what to expect from each endpoint.

Registration

First, you will need to first create an account at Seeuletter.com and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the API keys Panel.

Installation

The recommended way to install Seeuletter.com PHP Client is through Composer.

// Install Composer
curl -sS https://getcomposer.org/installer | php

// Add Seeuletter.com PHP client as a dependency
composer require seeuletter/seeuletter-php

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Usage

Create a new Letter

<?php
require 'vendor/autoload.php';

// Provide an API Key in the class constructor
// in order to instantiate the Seeuletter object
$apiKey = 'API Key here';
$seeuletter = new \Seeuletter\Seeuletter($apiKey);

$to_address = array(
  'name'                  => 'Seeuletter',
  'address_line1'         => '30 rue de rivoli',
  'address_line2'         => '',
  'address_city'          => 'Paris',
  'address_country'       => 'France',
  'address_postalcode'    => '75004'
);

$letter = $seeuletter->letters()->create(array(
  'to'                  => $to_address,
  'source_file'         => '@test.pdf',
  'description'         => 'Test Letters',
  'color'               => 'bw',
  'source_file_type'    => 'file',
  'postage_type'        => 'verte'
));

print_r($letter);

?>

Get all Letters

<?php
  require 'vendor/autoload.php';

  $seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

  $letters = $seeuletter->letters()->all();

  print_r($letters);
?>

Get a specific Letter

<?php
  require 'vendor/autoload.php';

  $seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

  $letter = $seeuletter->letters()->get('LETTER_ID');

  print_r($letter);
?>

Examples

We've provided various examples for you to try out here.

=======================

Copyright © 2017 Seeuletter.com

Released under the MIT License, which can be found in the repository in LICENSE.txt.