Download the PHP package vmeretail/servicedeskify-php-sdk without Composer
On this page you can find all versions of the php package vmeretail/servicedeskify-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vmeretail/servicedeskify-php-sdk
More information about vmeretail/servicedeskify-php-sdk
Files in vmeretail/servicedeskify-php-sdk
Package servicedeskify-php-sdk
Short Description A Laravel package for interacting with the Vme Retail ServiceDeskify API.
License MIT
Informations about the package servicedeskify-php-sdk
ServiceDeskify Laravel SDK
A Laravel package for ServiceDeskify, built on Saloon.
The package handles OAuth password-grant authentication, encrypted token caching,
token refresh and one automatic re-authentication after an API 401.
Requirements
- PHP 8.2 or newer
- Laravel 11, 12 or 13
Laravel 11 is supported for applications that still require it, although its upstream security-fix window ended in March 2026. Prefer Laravel 12 or 13 for new applications.
Installation
The package service provider is discovered automatically. Publish the configuration file if you need to customise caching or token timing:
Configure the credentials supplied by VME Retail:
For the ServiceDeskify test environment, set
SERVICEDESKIFY_URL=https://helpdesk-test.vme.co.
The configured Laravel cache store is used by default. A different store may be
selected with SERVICEDESKIFY_CACHE_STORE. Advanced token-cache settings are
also configurable. The selected store must support Laravel atomic locks.
Incidents
Import the package facade and typed input objects:
Incidents can be listed, retrieved, closed and given closure details:
Paginated methods return PaginatedData with typed items and the usual page,
total, link and range values. A page can also be iterated directly or passed to
count().
To process every result without hand-rolling page loops, incidents, posts and
locations expose lazy() and each(). Returning false from an each()
callback stops iteration early.
Replies and attachments
Attachments may be Laravel UploadedFile instances, SplFileInfo instances or
readable filesystem paths. Requests without attachments are JSON; requests with
attachments are multipart.
Download an attachment using its incident, post and attachment IDs:
Locations, software assets and releases
Software-asset lists return summary DTOs containing the ID, name and current
release ID. find() returns the full software-asset DTO. Creating a release
requires an agent account, and posting a version that already exists for that
software asset results in a ValidationException.
Errors
Failed responses are mapped to package exceptions:
AuthenticationExceptionfor401and403NotFoundExceptionfor404ValidationExceptionfor422UnexpectedResponseExceptionwhen a successful response is missing required identity fieldsServiceDeskifyRequestExceptionfor other API and transport failures
Exceptions expose the HTTP status, response body and validation errors where
available. All exceptions above extend ServiceDeskifyRequestException.
Credentials are never included in exception messages.
Testing consuming applications
The package uses Saloon core and does not require Saloon's Laravel plugin. Use
Saloon's global MockClient and provide an OAuth response before API responses:
Destroy the global mock in each test's teardown to prevent it leaking into other tests.
Migrating from v2
Version 3 is a complete rewrite. The following v2 classes have been removed:
PublicClientandAuthenticatedClientSingletonAbstractApiResourceIncidents,IncidentPosts,IncidentCloseandIncidentClosureDetailsLocations,UserLocationsandSoftwareAssetsServiceDeskifyResponseObjectandServiceDeskifyConstants
Applications no longer authenticate manually or construct resource classes.
Configure credentials in Laravel, use the ServiceDeskify facade, pass typed
input objects and consume typed result objects.
The obsolete users/locations resource is not included because the current
ServiceDeskify service does not expose that route.
All versions of servicedeskify-php-sdk with dependencies
illuminate/contracts Version ^11.0|^12.0|^13.0
illuminate/http Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0
saloonphp/saloon Version ^4.0