PHPackages                             checkfront/checkfront - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. checkfront/checkfront

ActiveLibrary[API Development](/categories/api)

checkfront/checkfront
=====================

Wrapper library for using the Checkfront API

1.3(7y ago)223.3kMITPHPPHP >=5.3

Since Oct 11Pushed 7y ago2 watchersCompare

[ Source](https://github.com/htmlgraphic/Checkfront-PHP-SDK)[ Packagist](https://packagist.org/packages/checkfront/checkfront)[ Docs](https://github.com/htmlgraphic/PHP-SDK)[ RSS](/packages/checkfront-checkfront/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (4)Used By (0)

[![Build Status](https://camo.githubusercontent.com/90ee3e44461658d40eb6c98116edeff1ddf3a3ef2a9177820f377500f6903ecb/68747470733a2f2f7472617669732d63692e6f72672f68746d6c677261706869632f436865636b66726f6e742d5048502d53444b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/htmlgraphic/Checkfront-PHP-SDK)

Checkfront PHP SDK (v1.3)
=========================

[](#checkfront-php-sdk-v13)

The [Checkfront API 3.0](http://www.checkfront.com/developers/api/) allows you to build integrations and custom applications that interact with a remote Checkfront account.

This repository contains the open source PHP SDK and various example scripts. Except as otherwise noted, the Checkfront PHP SDK is licensed under the Apache Licence, Version 2.0 ()

---

Features
--------

[](#features)

The Checkfront API SDK (v1.3) provides the following functionality:

- OAuth2 authorization and authentication.
- OAuth2 token refresh.
- Token pair authorization.
- Session handing.
- Access to Checkfront Objects via GET, POST, PUT and DELETE request.
- Notifications via API Hook
- Installation via PHP Composer

Installation & Usage
------------------------

[](#installation--usage)

This repo is setup to extend off of the library created by Checkfront. To update this library, a Composer.json file has been created.

If you are not using [Composer](http://getcomposer.org), you should be. It's an excellent way to manage dependencies in your PHP application.

Quick Start
-----------

[](#quick-start)

Let's install Checkfront-PHP-DK via the following few commands:

> Type `composer` for more options:

```
$ composer init --require="checkfront/checkfront:1.3" -n
$ composer install

```

```
require 'vendor/autoload.php';
```

Now the needed code should be available within your project. At the top of your PHP script require the autoloader, if you are using a MVC such as CodeIgnitor or Laravel review their autoload guides.

**API credintials:** [https://{your-company}.checkfront.com/manage/developer/](https://%7Byour-company%7D.checkfront.com/manage/developer/)

> The repo example files are a good place to start.

```
PHP-SDK                     # → Root of Service
└── examples/
   └── cart
	   ├── Cart.php         # → Main wrapper class, ADD API KEY
	   ├── create.php       # → Process $_POST request, add to cart session
	   ├── Form.php         # → Various PHP functions
	   ├── index.php        # → Default view, list available inventory
	   └── README.md        # → File overview & tips
```

#### OAuth2 Access

[](#oauth2-access)

```