vmeretail / servicedeskify-php-sdk
The ServiceDeskify helpdesk PHP library provides convienient access to VmeRetail's ServiceDeskify api from apps written in PHP. It includes a pre-defined set of classes for API resources.
Installs: 16 010
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 5
Forks: 0
Open Issues: 0
Requires
- php: ~7.0|~8.0
- guzzlehttp/guzzle: ~6.0|~7.0
This package is auto-updated.
Last update: 2024-10-31 00:17:30 UTC
README
Service Deskify Helpdesk PHP
The ServiceDeskify helpdesk PHP library provides convienient access to VmeRetail's ServiceDeskify api from apps written in PHP. It includes a pre-defined set of classes for API resources.
Composer
We recommend installing this library via composer;
composer require vmeretail/servicedeskify-php-sdk
Along with composer's autoloader:
require 'vendor/autoload.php';
You can later pull the latest changes.
composer update
Dependencies
Getting Started
Create an authenticated client first in order to get access to the API exposed by ServiceDeskify. The credentials and keys are provided by VmeRetail.
(new \VmeRetail\ServiceDeskify\Http\PublicClient())
->setBaseUrl(\VmeRetail\ServiceDeskify\ServiceDeskifyConstants::HELPDESK_API_URL_TEST)
->authenticate('example@vmeretail.com', 'password', '2', 'client_secret_SNo1LKmrXdUTdjTdb1bC4eZ6l');
After, you would be able to access an API resource like so:
$incidentsApi = new \VmeRetail\ServiceDeskify\Incidents();
And be able to make API calls:
$serviceDeskifyResponseObject = $incidentsApi->create([ //...properties ]);
Then you are able to get the body of the response as a JSON object:
$serviceDeskifyResponseObject->getBodyAsJson();
Reference API
Details about the properties that are to be passed in and responses can be found (https://test.helpdesk.vme.co/docs/)