Weave Code
Zammad Api Client Php Laravel Package
zammad/zammad-api-client-php
A PHP client for the Zammad helpdesk API, letting you authenticate and work with tickets, users, and other resources from your PHP application. Install via Composer; requires PHP 7.2+ and Zammad 3.4.1 or newer. A v3 release candidate adds typed DTOs and PSR-18 support.
Zammad API Client for PHP is a Composer package that lets PHP applications talk to the Zammad open-source helpdesk API. It supports Zammad 3.4.1 and newer and requires PHP 7.2+. Configuration is minimal: instantiate the Client with your URL and credentials, then manage tickets, users, and other resources. A v3 release candidate adds typed DTOs, a PSR-18 HTTP client, and typed exceptions for PHP 8.1+.
- Simple Client setup with URL, username, and password
- Optional request timeout, debug output, and SSL verification settings
- Works with Zammad 3.4.1+ via the stable
^2.3release - v3 RC with typed DTOs and PSR-18 support
- Example code included in the
examplesdirectory
Frequently asked questions about Zammad Api Client Php
- How do I install zammad/zammad-api-client-php in a Laravel application?
- Install it with Composer using zammad/zammad-api-client-php:^2.3 for the stable v2 line or zammad/zammad-api-client-php:^3.0@RC for the v3 release candidate. Laravel's autoloader handles the package classes, so you do not need a manual require once it is installed. Then bind the Zammad Client in a service provider or resolve it from a small service class using credentials from config or .env.
- Does this Zammad API client support Laravel 10 and Laravel 11?
- Yes, because it is a framework-agnostic PHP client rather than a Laravel-only package, it can be used in Laravel 10 or 11 as long as the PHP requirement is met. The v2 line requires PHP 7.2 or newer, while the v3 release candidate requires PHP 8.1 or newer. There is no bundled Laravel service provider, so you register the client yourself in the container.
- How do I authenticate the Zammad API client in Laravel?
- The Client accepts a Zammad URL plus username and password credentials, and the package also supports OAuth2, HTTP tokens, and basic auth according to the integration notes. Store credentials in Laravel config or environment variables instead of hardcoding them in controllers. For OAuth2, decide whether Laravel Passport, Sanctum, or a custom token rotation strategy will manage and refresh tokens.
- Can I use this Zammad client inside Laravel queues and jobs?
- Yes, the client uses stateless HTTP calls, so bulk ticket updates, imports, and sync operations can run in Laravel queue jobs. Instantiate or inject the Client inside the job and call resource methods such as save or delete there. Use Laravel's throttle middleware or rate limiter when high-frequency Zammad API calls could exceed API limits.
- How should I handle Zammad API errors in a Laravel app?
- The v2 client exposes hasError and getLastResponse so you can inspect failures after each call, while the v3 release candidate adds typed exceptions. Wrap client calls in a Laravel service layer and convert failures into Laravel HTTP client exceptions or custom domain exceptions for consistent handling. Log response details through Laravel logging or Telescope so failed ticket and user operations are traceable.
- Is zammad/zammad-api-client-php a Laravel package or a general PHP client?
- It is a general PHP API client for Zammad, not a Laravel-specific package. You integrate it with Laravel by binding the Client in a service provider, wrapping it in services such as a ticket service, and returning responses through Laravel API Resources if needed. It does not ship Eloquent models or a ready-made Laravel facade.
- How do I test Zammad API integration in Laravel without a live helpdesk?
- Mock the Zammad Client methods or the underlying HTTP layer so tests do not call a real Zammad instance. With the v2 client you can use Mockery or a Guzzle mock handler, and the v3 release candidate's PSR-18 HTTP client makes injecting a mock HTTP client easier. Keep service classes thin so Laravel feature tests can swap in a fake client through the container.
- Which Zammad and PHP versions does this API client support?
- The client supports Zammad 3.4.1 and newer. The stable v2 line requires PHP 7.2 or newer, while the v3 release candidate requires PHP 8.1 or newer and adds typed DTOs and typed exceptions. Pin the Composer constraint you need and monitor Zammad API deprecations before upgrading.
- Should I cache Zammad API responses in Laravel?
- Caching is useful for frequent read-heavy calls such as ticket lists, user lookups, or group metadata. Use Laravel Cache::remember with a short TTL and invalidate or refresh the cache after writes to tickets or users. Avoid caching sensitive ticket content unless your cache store and access controls meet your security requirements.
- What are alternatives to using this Zammad API client in Laravel?
- Alternatives include calling the Zammad REST API directly with Laravel's HTTP client or Guzzle, using Zammad webhooks for inbound events, or adopting a different helpdesk package with native Laravel support. This client is a good fit when you want a resource-based abstraction for tickets, users, and other Zammad objects without writing raw HTTP calls. The v3 release candidate is worth evaluating for typed DTOs, PSR-18 support, and typed exceptions.
Weaver
How can I help you explore Laravel packages today?