lob/lob-php

Lob.com API PHP wrapper.

Installs: 5 580

Dependents: 0

Stars: 20

Watchers: 18

Forks: 8

Open Issues: 1

Language: PHP

v1.4.2 2015-05-11 18:25 UTC

README

PHP version Build Status Dependency Status Coverage Status

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

Table of Contents

Getting Started

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

Registration

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

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

Installation

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

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

// Add Lob.com PHP client as a dependency
php composer.phar require lob/lob-php:1.4.*

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

require 'vendor/autoload.php';

Usage

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

Examples

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

API Documentation

Testing

Lob.com PHP Client uses PHPUnit for unit testing. In order to run the unit tests, you'll first need to install the dependencies of the project using Composer: php composer.phar install --dev. You can then run the tests using vendor/bin/phpunit.

Make sure you provide a test API Key in your phpunit.xml.

Copyright © 2013 Lob.com

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