PHPackages                             xalantis/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. xalantis/sdk

ActiveLibrary[API Development](/categories/api)

xalantis/sdk
============

Official PHP SDK for the Xalantis API

v0.2.0(3w ago)01MITPHPPHP ^8.1

Since Apr 4Pushed 3w agoCompare

[ Source](https://github.com/xalantis-hub/xalantis-php)[ Packagist](https://packagist.org/packages/xalantis/sdk)[ RSS](/packages/xalantis-sdk/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (1)Dependencies (6)Versions (3)Used By (0)

xalantis/sdk
============

[](#xalantissdk)

Official PHP SDK for the Xalantis API.

Release `0.2.0` covers every current public `/api/v1` endpoint exposed by Xalantis at the time of release.

Installation
------------

[](#installation)

```
composer require xalantis/sdk
```

Quick start
-----------

[](#quick-start)

```
use Xalantis\Xalantis;

$client = new Xalantis($_ENV['XALANTIS_API_KEY']);
```

For local testing:

```
$client = new Xalantis('sk_live_...', 'https://xalantis-application.test');
```

Covered domains
---------------

[](#covered-domains)

- Support / Service Desk: tickets, replies, attachments, reports, links, watchers, time entries, subtasks, incidents, service requests, SLA, automations, categories, tags, service catalog, agents.
- CRM: clients, representatives, contacts, deals, pipelines.
- Knowledge: articles, search, categories.
- Billing: subscription and invoices.
- Finance: invoices and expenses read-only APIs.
- Contracts: contracts, comments, negotiations, obligations, approvals, signatures, clauses, requests, PDF designs, assets, assignments.

Examples
--------

[](#examples)

### Support tickets

[](#support-tickets)

```
$ticket = $client->tickets()->create([
    'subject' => 'Login issue',
    'description' => 'Cannot login since the latest update',
    'requester_email' => 'user@example.com',
    'type' => 'incident',
    'priority' => 'high',
]);

$client->tickets()->reply($ticket['data']['uuid'], [
    'content' => 'We are investigating this.',
]);

$activities = $client->tickets()->activities($ticket['data']['uuid']);
```

### Attachments and downloads

[](#attachments-and-downloads)

```
$client->tickets()->uploadAttachment('ticket-uuid', [
    [
        'name' => 'file',
        'contents' => fopen('/path/to/file.pdf', 'r'),
        'filename' => 'file.pdf',
    ],
]);

$response = $client->tickets()->downloadAttachment('ticket-uuid', 'attachment-uuid');
file_put_contents('/tmp/attachment.pdf', $response->getBody()->getContents());
```

### CRM

[](#crm)

```
$clients = $client->clients()->list(['search' => 'Acme']);

$contact = $client->contacts()->create([
    'first_name' => 'Awa',
    'email' => 'awa@example.com',
]);

$client->deals()->update('deal-uuid', [
    'stage_uuid' => 'stage-uuid',
]);
```

### Knowledge

[](#knowledge)

```
$articles = $client->knowledge()->search(['search' => 'SLA']);
$article = $client->knowledge()->get('how-to-configure-sla');
```

### Billing and finance

[](#billing-and-finance)

```
$subscription = $client->billing()->subscription();
$billingInvoices = $client->billing()->listInvoices();
$expenses = $client->finance()->listExpenses();
```

### Contracts

[](#contracts)

```
$contract = $client->contracts()->get('contract-uuid');

$client->contracts()->addComment($contract['data']['uuid'], [
    'content' => 'Reviewed by legal.',
]);

$client->contracts()->submitForApproval($contract['data']['uuid']);
$client->contracts()->requestSignatures($contract['data']['uuid']);
```

Error handling
--------------

[](#error-handling)

```
use Xalantis\Exceptions\XalantisException;

try {
    $client->tickets()->create([
        'subject' => '',
        'description' => 'Missing subject',
        'requester_email' => 'user@example.com',
    ]);
} catch (XalantisException $e) {
    echo $e->errorCode;
    echo $e->status;
    print_r($e->details);
}
```

Safety notes
------------

[](#safety-notes)

- UUID path parameters are validated client-side to reduce accidental path misuse.
- Destructive operations such as delete, merge, split, waive, archive and attachment deletion are available because they are part of the public API. Applications should ask users for confirmation before calling them.
- The SDK does not bypass backend permissions, plan gates, tenant scoping or rate limits.
- Packagist versioning should be driven by Git tags such as `v0.2.0`.

Development
-----------

[](#development)

```
composer install
composer test
```

License
-------

[](#license)

MIT

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance96

Actively maintained with recent releases

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~115 days

Total

2

Last Release

21d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/22053891?v=4)[Lamine AZINAKOU](/maintainers/agazinakou)[@agazinakou](https://github.com/agazinakou)

---

Top Contributors

[![agazinakou](https://avatars.githubusercontent.com/u/22053891?v=4)](https://github.com/agazinakou "agazinakou (4 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/xalantis-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/xalantis-sdk/health.svg)](https://phpackages.com/packages/xalantis-sdk)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3661.3M49](/packages/tencentcloud-tencentcloud-sdk-php)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

353.6k](/packages/eslazarev-wildberries-sdk)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k832.6k55](/packages/neuron-core-neuron-ai)[files.com/files-php-sdk

Files.com PHP SDK

2482.9k](/packages/filescom-files-php-sdk)[volcengine/volcengine-php-sdk

119.5k](/packages/volcengine-volcengine-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)