mtymek/mt-zendesk-api

ZF2 module wrapper for Zendesk API

1.1.1 2016-07-12 15:30 UTC

Requires

• php: ^5.4 || ^7.0
• zendesk/zendesk_api_client_php: ^1.0
• zendframework/zend-servicemanager: ^2.6 || ^3.0.3

Requires (Dev)

• phpunit/phpunit: *

BSD 2-Clause

• Mateusz Tymek

• api
• zf2
• module
• Zendesk

README

Introduction

This module allows easy access of Zendesk API from within Zend Framework 2 application.

Installation

Installation is supported via Composer:

1. Add "mtymek/mt-zendesk-api":"dev-master" to your composer.json file and run php composer.phar update.
2. Add MtZendeskApi to your config/application.config.php file under the modules key.

Configuration

1. Copy config/zendesk.local.php.dist file into your main application's config/autoload' directory, rename it to zendesk.local.php`
2. Replace placeholder values with subdomain, username and API token read from Zendesk settings page

Example:

return [
    'zendesk' => [
        'subdomain' => 'mycompany',
        'username'  => '[e-mail]',
        'token'     => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    ],
];

Usage

Once configured, MtZendeskApi will expose Zendesk API client using ServiceManager. Example usage (from controller):

$client = $this->getServiceLocator()->get('Zendesk\API\Client');
$newTicket = $client->tickets()->create(
    [
        'subject'   => 'Question to Support Team',
        'tags'      => ['tag1', 'tag2'],
        'requester' => [
            'email' => '[e-mail]',
        ],
        'comment'   => [
            'body' => "Ticket body"
        ],
        'priority'  => 'normal'
    ]
);