deskpro/deskpro-api-php

Library for using the DeskPRO API with PHP

DeskPRO PHP SDK

The DeskPRO PHP SDK is a simple class to access and interact with DeskPRO's REST API. It wraps the actual requests up in an easy-to-use API of simple PHP calls., _(*1)

For more information on the underlying REST API, please see our API documentation., _(*2)

PHP SDK Requirements

The PHP SDK requires PHP >= 5.2 with the cURL extension., _(*3)

Using The PHP SDK

The best way to get started with the PHP SDK is to view the fully functioning examples in the examples folder., _(*4)

The following larger projects may also serve as a useful reference:, _(*5)

• New ticket from a web form
• Convert your tickets to PDF documents

Full documentation on the underlying API is maintained in the API documentation section in our Knowledgebase., _(*6)

Note that you can explore the API interactively on your own helpdesk using the DeskPRO API browser., _(*7)

Quick Start

1. Clone or download this repository and put the source files somewhere in your project., _(*8)

2. Include the deskpro-api.php file:, _(*9)

require 'deskpro-api.php';

3. Create a new instance of the API class:, _(*10)

$api = new \DeskPRO\Api('http://example.com/deskpro', '123:XYZ');

4. Use $api to send API requests to your DeskPRO helpdesk. Refer to the examples directory for fully-functional examples., _(*11)

Using Composer

You can also install the API library through composer: https://packagist.org/packages/deskpro/deskpro-api-php, _(*12)

$ php composer.phar require deskpro/deskpro-api-php dev-master