https://github.com/testmonitor/topdesk-client

The TestMonitor TOPdesk Client.
https://github.com/testmonitor/topdesk-client

api client topdesk

Last synced: about 2 months ago
JSON representation

The TestMonitor TOPdesk Client.

• Host: GitHub
• URL: https://github.com/testmonitor/topdesk-client
• Owner: testmonitor
• License: mit
• Created: 2019-11-20T22:14:33.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T08:00:54.000Z (3 months ago)
• Last Synced: 2024-11-07T17:16:54.672Z (2 months ago)
• Topics: api, client, topdesk
• Language: PHP
• Homepage:
• Size: 104 KB
• Stars: 2
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# TestMonitor TOPdesk Client

[![Latest Stable Version](https://poser.pugx.org/testmonitor/topdesk-client/v/stable)](https://packagist.org/packages/testmonitor/topdesk-client)

[![CircleCI](https://img.shields.io/circleci/project/github/testmonitor/topdesk-client.svg)](https://circleci.com/gh/testmonitor/topdesk-client)

[![StyleCI](https://styleci.io/repos/223037352/shield)](https://styleci.io/repos/223037352)

[![codecov](https://codecov.io/gh/testmonitor/topdesk-client/graph/badge.svg?token=8KKHUCJK5W)](https://codecov.io/gh/testmonitor/topdesk-client)

[![License](https://poser.pugx.org/testmonitor/topdesk-client/license)](https://packagist.org/packages/testmonitor/topdesk-client)

This package provides a very basic, convenient, and unified wrapper for the TOPdesk REST API.

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Examples](#examples)

- [Tests](#tests)

- [Changelog](#changelog)

- [Contributing](#contributing)

- [Credits](#credits)

- [License](#license)

## Installation

To install the client you need to require the package using composer:

	$ composer require testmonitor/topdesk-client

Use composer's autoload:

```php

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

```

You're all set up now!

## Usage

You'll have to instantiate the client using your credentials:

```php

$topdesk = new \TestMonitor\TOPdesk\Client('https://mytopdesk.topdesk.net', 'username', 'password');

```

Next, you can start interacting with TOPdesk.

## Examples

Get a list of incidents out of TOPdesk:

```php

$topdesk->incidents();

```

or create a new incident in TOPdesk:

```php

$incident = $topdesk->createIncident(new \TestMonitor\TOPdesk\Resources\Incident([

    'callerName' => 'John Doe',

    'callerEmail' => '[email protected]',

    'status' => 'firstLine',

    'number' => 'I1234',

    'briefDescription' => 'Some Request',

    'request' => 'Some Request Description'

]));

```

## Tests

The package contains integration tests. You can run them using PHPUnit.

    $ vendor/bin/phpunit

## Changelog

Refer to [CHANGELOG](CHANGELOG.md) for more information.

## Contributing

Refer to [CONTRIBUTING](CONTRIBUTING.md) for contributing details.

## Credits

* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)

* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)

* **Frank Keulen** - *Developer* - [FrankIsGek](https://github.com/frankisgek)

* **Muriel Nooder** - *Developer* - [ThaNoodle](https://github.com/thanoodle)

## License

The MIT License (MIT). Refer to the [License](LICENSE.md) for more information.