invoiced/oauth1-xero

Xero OAuth 1.0 Client Provider for The PHP League OAuth1-Client

1.1 2017-08-09 20:58 UTC

README

Latest Stable Version Software License Build Status Coverage Status Scrutinizer Code Quality Total Downloads HHVM Status

This package provides Xero OAuth 1.0 support for the PHP League's OAuth 1.0 Client.

Installation

To install, use composer:

composer require invoiced/oauth1-xero

Usage

Usage is the same as The League's OAuth client, using Invoiced\OAuth1\Client\Server\Xero as the provider.

Public API

Follows Xero Public Applications.

$server = new Invoiced\OAuth1\Client\Server\Xero([
    'identifier'      => 'your-identifier',
    'secret'          => 'your-secret',
    'callback_uri'    => 'https://your-callback-uri/',
    'partner'         => false,
]);

Private API

Follows Xero Private Applications.

$server = new Invoiced\OAuth1\Client\Server\Xero([
    'identifier'      => 'your-identifier',
    'secret'          => 'your-secret',
    'callback_uri'    => 'https://your-callback-uri/',
    'partner'         => false,
    'rsa_private_key' => '/path/private.pem',
    'rsa_public_key'  => '/path/public.pem',
]);

Partner API

Follows Xero Partner Applications.

$server = new Invoiced\OAuth1\Client\Server\Xero([
    'identifier'      => 'your-identifier',
    'secret'          => 'your-secret',
    'callback_uri'    => 'https://your-callback-uri/',
    'rsa_private_key' => '/path/private.pem',
    'rsa_public_key'  => '/path/public.pem',
]);