This is the second version of our PHP API client and it is currently in BETA. The previous version of the API client can be found on the v1 branch.

This client only supports Zendesk's API v2. Please see our API documentation for more information.

• PHP 5.5+

The Zendesk PHP API client can be installed using Composer.

Inside of composer.json specify the following:

{
  "require": {
    "zendesk/zendesk_api_client_php": "dev-master"
  }
}

Configuration is done through an instance of Zendesk\API\Client. The block is mandatory and if not passed, an error will be thrown.

use Zendesk\API\Client as ZendeskAPI;

$subdomain = "subdomain";
$username  = "username";
$token     = "6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv"; // replace this with your token
// $password = "123456";

$client = new ZendeskAPI($subdomain, $username);
$client->setAuth('token', $token); // set either token or password

// Get all tickets
$tickets = $client->tickets()->findAll();
print_r($tickets);

// Create a new ticket
$newTicket = $client->tickets()->create([
    'subject'  => 'The quick brown fox jumps over the lazy dog',
    'comment'  => [
        'body' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, ' .
                  'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
    ],
    'priority' => 'normal'
]);
print_r($newTicket);

// Update multiple tickets
$client->ticket([123, 456])->update([
    'status' => 'urgent'
]);

// Delete a ticket
$client->ticket(123)->delete();

$attachment = $client->attachments()->upload([
    'file' => getcwd().'/tests/assets/UK.png',
    'type' => 'image/png',
    'name' => 'UK.png' // Optional parameter, will default to filename.ext
]);

The test suite is run via phpunit. Note that these are all live tests that must be run targeted at a real Zendesk instance. Credentials can be provided by setting the environment variables in phpunit.xml; a sample is provided at phpunit.xml.dist.

To run the unit tests: vendor/bin/phpunit --testsuite "Zendesk API Unit Test Suites"

To run the live tests: vendor/bin/phpunit --testsuite "Zendesk API Live Test Suites"

$tickets = $this->client->tickets()->sideload(['users', 'groups'])->findAll();

This project strictly follows the PSR-2 coding standard.

PHP Codesniffer is used to verify that the standard is being followed.

In addition to the PSR2 standard which we try to follow the following rules as much as possible:

All Classes, Class Methods and Properties should have docblocs.

Class docblocks should contain:

• A short description of the class
• Any methods available that are called via magic method with what that method returns.

A good example is

/**
 * Client class, base level access
 *
 * @method Debug debug()
 * @method Tickets ticket()
 * @method Views views()
 */

Method docblocks should contain:

• A short description of what the method does.
• The parameters passed with what type to expect.
• Description of the parameters passed with examples(optional).
• The type of the return.
• All the possible exceptions the method may throw.

A good example of this is

/**
 * Find a specific ticket by id or series of ids
 *
 * @param integer|null $id
 * @param array        $queryParams
 *
 * @return Array
 *
 * @throws MissingParametersException
 * @throws \Exception
 */

Class properties docblocs should contain:

• A short description of the property (optional)
• The var type

A good example of this

/**
 * This contains the Auth object to be used for authenticating with the Client
 *
 * @var Zendesk\API\Utilities\Auth
 */

The short notations for declaring arrays ([]) is preferred over the longer array().

Align =>s following the longest key to make the arrays easier to read.

[
    'findAll'             => "users/{userId}/{$this->resourceName}.json",
    'find'                => "users/{userId}/{$this->resourceName}/{id}.json",
    'update'              => "users/{userId}/{$this->resourceName}/{id}.json",
    'makePrimary'         => "users/{userId}/{$this->resourceName}/{id}/make_primary.json",
    'verify'              => "users/{userId}/{$this->resourceName}/{id}/verify.json",
    'requestVerification' => "users/{userId}/{$this->resourceName}/{id}/request_verification.json",
    'delete'              => "users/{userId}/{$this->resourceName}/{id}.json",
    'create'              => "users/{userId}/{$this->resourceName}.json",
    'createAsEndUser'     => "end_users/{userId}/{$this->resourceName}.json",
]

Align the = for grouped assignment statements.

$headers             = 'sample';
$lastRequestBody     = 'example';
$lastResponseCode    = 'something';
$lastResponseHeaders = 'test';
$lastResponseError   = 'test2';

• Traits are added after class constants and arranged alphabetically when declared.
• Group traits accordingly by adding a new line after each group.
• Groups are ordered as follows:

1. Instantiator
2. Single resource
3. Bulk traits

When adding a resource, use traits to define available API calls. Resource traits are namespaced under Zendesk\API\Traits\Resource.

Single Resource

• Create
• Delete
• Find
• FindAll
• Update
• Defaults - this adds Find, FindAll, Create, Update, and Delete

Bulk traits

• CreateMany
• DeleteMany
• FindMany
• UpdateMany

Use Zendesk\API\Traits\Utility\InstantiatorTrait when you want a resource to be chainable to other resources. See Zendesk/API/Resources/Tickets.php.

$this->client->tickets()->comments()->findAll();

1. Fork the project.
2. Make your feature addition or bug fix.
3. Add tests for it. This is important so that we don't break your improvement in a future version unintentionally.
4. Please follow the coding standard described above.
5. Commit and do not mess with version or history. (If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when we pull)
6. Send a pull request. Bonus points for topic branches.

Copyright 2013-present Zendesk

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.