recurly/recurly-client-php

There is no license information available for the latest version (dev-master) of this package.

dev-master 2014-02-09 04:35 UTC

This package is not auto-updated.

Last update: 2024-11-03 02:54:01 UTC


README

##NOTE This repo was created to add Recurly's official PHP SDK to packagist for Composer at a time that it did not exist. If you are looking for the maintained client, please visit the repo this one is forked from.

Recurly PHP Client

The Recurly PHP Client library is an open source library to interact with Recurly's subscription management from your PHP website. The library interacts with Recurly's REST API.

Note: This version uses Recurly API v2. There are substantial differences between this version of the client library and versions before 0.5.0. Please be careful when upgrading.

Installation

If you already have git, the easiest way to download the Recurly PHP Client is with the git command:

git clone git://github.com/recurly/recurly-client-php.git /path/to/include/recurly

Alternatively, you may download the PHP files in the lib/ directory and place them within your PHP project.

Requirements

The PHP library depends on PHP 5.3.0 (or higher) and libcurl compiled with OpenSSL support. Open up a phpinfo(); page and verify that under the curl section, there's a line that says something like:

libcurl/7.19.5 OpenSSL/0.9.8g zlib/1.2.3.3 libidn/1.15

Initialization

Load the Recurly library files and set your API Key globally:

<?php
require_once('./lib/recurly.php');

Recurly_Client::$apiKey = '012345678901234567890123456789ab';

If you are using Recurly.js, specify your private_key:

Recurly_js::$privateKey = "0123456789abcdef0123456789abcdef";

API Documentation

Please see the Recurly API for more information.