Download the PHP package uvdesk/api-bundle without Composer
On this page you can find all versions of the php package uvdesk/api-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download uvdesk/api-bundle
More information about uvdesk/api-bundle
Files in uvdesk/api-bundle
Package api-bundle
Short Description Easily integrate with your community helpdesk system using the uvdesk api bundle.
License MIT
Informations about the package api-bundle
The API Bundle empowers integration developers to seamlessly interact with the UVDesk Community Helpdesk system using its robust RESTful API. It provides a comprehensive set of endpoints that allow external applications to perform key operations—such as creating, updating, and retrieving tickets, managing customers and agents and smooth integration with third-party platforms and custom systems.
Installation
This bundle can be easily integrated into any symfony application (though it is recommended that you're using Symfony 4 as things have changed drastically with the newer Symfony versions). Before continuing, make sure that you're using PHP 8.1 or higher and have Composer installed.
To require the api bundle into your symfony project, simply run the following from your project root:
After installing api bundle run the below command:
Finally clear your project cache by below command(write prod if running in production environment i.e --env prod):
API References
Use the below available apis to interact with your helpdesk system.
Session:
-
POST /api/v1/session/login
Authenticate user credentials and generate an access token in response to access helpdesk apis as the authenticated user.
Headers:
To generate the required auth token, simply encode the user's email and password separated by a colon in base64 format, i.e. base64_encode("email:password").
Sample Response:
-
POST /api/v1/session/logout
Invalidates an authenticated user access token so that it can't be used anymore.
Headers:
ACCESS_TOKEN: The api access token that was generated either using the session login api or directly from the dashboard.
Sample Response:
Tickets:
More examples of ticket related apis can be found over here.
-
GET /tickets
Get a collection of all user accessible tickets.
Headers:
ACCESS_TOKEN: The api access token that was generated either using the session login api or directly from the dashboard.
Sample Response:
License
The API Bundle and libraries included within the bundle are released under released under the OSL-3.0 license