/helpscout-docs-api-php

DocsApi client for HelpScout

Primary LanguagePHP

helpscout-docs-api-php example workflow

PHP Wrapper for the Help Scout Docs API. More information about Docs API: http://developer.helpscout.net/docs-api/.

Inspired and followed by original https://github.com/helpscout/helpscout-api-php repository.

Requirements

  • PHP >= 8

Installation

This will install latest 4.* version:

composer require m1x0n/helpscout-docs-api-php
Package version PHP version
1.* >= 5.5
2.* >= 7.3
3.* >= 7.4
4.* >= 8

Previous versions are also available and could be installed in following way:

composer require m1x0n/helpscout-docs-api-php:^2

Example Usage:

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

use HelpScoutDocs\DocsApiClient;

// Initialize client
$docsApiClient = new DocsApiClient('your-api-key');

// Get all collections
$collections = $docsApiClient->getCollections();

More examples

Changelog

Covered Docs API methods

Contributions

Contributions are highly appreciated.

Feel free to file an issue, send a PR, make a suggestion etc.

TODO

Use jms/serializer for deserialization