waredesk/waredesk-api

0.1.0-alpha.29 2017-06-22 18:04 UTC

This package is not auto-updated.

Last update: 2024-11-24 03:40:21 UTC


README

Build Status StyleCI Scrutinizer Code Quality Code Coverage Code Climate Latest Stable Version

This library is aimed at wrapping the Waredesk API into a simple to use PHP Library. Feel free to contribute.

Table Of Content

  1. Requirements
  2. Installation
  3. Logging
  4. License

Requirements

This library uses PHP 7.1+.

To use the Waredesk library, you have to obtain credentials from Waredesk. For every request, you will have to provide the API key.

Installation

It is recommended that you install the Waredesk library through composer. To do so, run the Composer command to install the latest stable version of Waredesk:

composer require waredesk/waredesk-api

Logging

The Waredesk constructor takes a PSR-3 compatible logger.

Requests & responses are logged at DEBUG level. At INFO level only the event is reported, not the response content. More severe problems (e.g. no connection) are logged with higher severity.

License

This library is licensed under The MIT License (MIT).