leadferret/api-php-sdk

Client library for LeadFerret APIs

dev-master 2015-11-14 01:04 UTC

Requires

• php: >=5.5.1
• guzzlehttp/guzzle: ^6.0
• solvire/common-utilities: dev-master
• vlucas/phpdotenv: ^2.0

Requires (Dev)

• phpunit/phpunit: 3.7.*

Apache-2.0

• api
• sdk
• leadferret

README

LeadFerret-API-PHP-SDK

Description

Client SDK for the LeadFerret API - written in PHP. Allows you to work with the LeadFerret End-User API.

This is in development - not ready for use

Installation

For now just check out the repo from git. Later we will add it to packagyst so you can composify it.

git clone https://github.com/leadferret/LeadFerret-API-PHP-SDK.git

sub-Alpha

This library is in sub-Alpha state. Contact us if you wish to have more details. If you wish to work on this or add features please fork it and send a pull request.

Usage

Make sure you set up your .env file properly. This client uses DotEnv to handle the environment and config items.

This distribution comes with an example config .env.example and inside this file are some of the environment variables that should be used to set up the application.

Requirements

• PHP 5.5.1 or higher
• PHP JSON extension

Developer Documentation

Please note documentation found at apiary.io

Basic Example

See the examples/ directory for examples of the key client features.

<?php

include_once '../bootstrap.php';
use LeadFerret\LFClient;

$client = new LFClient();
$token = $client->authenticate();

echo $token;