PHPackages                             datana-gmbh/zendesk-api - 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. datana-gmbh/zendesk-api

ActiveLibrary[API Development](/categories/api)

datana-gmbh/zendesk-api
=======================

API for Zendesk

2.0.1(2y ago)08.4kMITPHPPHP >=8.3

Since Jan 9Pushed 2y agoCompare

[ Source](https://github.com/datana-gmbh/zendesk-api)[ Packagist](https://packagist.org/packages/datana-gmbh/zendesk-api)[ RSS](/packages/datana-gmbh-zendesk-api/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (5)Dependencies (16)Versions (6)Used By (0)

zendesk-api
===========

[](#zendesk-api)

BranchPHPCode Coverage`master`[![PHP](https://github.com/datana-gmbh/zammad-api/workflows/PHP/badge.svg?branch=master)](https://github.com/datana-gmbh/zammad-api/actions)[![Code Coverage](https://camo.githubusercontent.com/02b5dc0490a93fa83ef21788d2042b0d037d0be35c324fcc5728ce3c1134798d/68747470733a2f2f636f6465636f762e696f2f67682f646174616e612d676d62682f7a616d6d61642d6170692f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/datana-gmbh/zammad-api)Usage
-----

[](#usage)

### Installation

[](#installation)

```
composer require datana-gmbh/zendesk-api
```

### Setup

[](#setup)

```
use Zendesk\API\HttpClient;

$subdomain = 'company'
$username  = 'username'
$token  = '...'

$client = new HttpClient($subdomain);
$client->setAuth('basic', [ 'token' => $token, 'username' => $username ]);
```

Tickets
-------

[](#tickets)

In your code you should type-hint to `Datana\Zendesk\Api\TicketsApiInterface`

### Create a ticket

[](#create-a-ticket)

```
use Datana\Zendesk\Api\Domain\Value\Ticket;
use Datana\Zendesk\Api\TicketsApi;
use Zendesk\API\HttpClient;

$client = new HttpClient(/* ... */);

$ticketsApi = new TicketsApi($client);

$ticket = new Ticket(/* ... */);
$responseAsBool = $ticketsApi->create($ticket);
```

### Create a ticket with attachments

[](#create-a-ticket-with-attachments)

```
use Datana\Zendesk\Api\Domain\Value\Ticket;
use Datana\Zendesk\Api\TicketsApi;
use Datana\Zendesk\Api\AttachmentsApi;
use Zendesk\API\HttpClient;

$client = new HttpClient(/* ... */);

$attachmentsApi = new AttachmentsApi($client);

$upload = $attachmentsApi->create(/** ... */)

$ticketsApi = new TicketsApi($client);

$ticket = new Ticket(/* ... */ );
$responseAsBool = $ticketsApi->create($ticket);
```

### Custom field definition

[](#custom-field-definition)

```