PHPackages                             vlsv/platformaofd-api-client - 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. vlsv/platformaofd-api-client

ActiveLibrary

vlsv/platformaofd-api-client
============================

Клиент для работы с PlatformaOFD Client API

1.1.0(1y ago)314proprietaryPHPPHP ^8.2CI passing

Since Oct 28Pushed 1y ago1 watchersCompare

[ Source](https://github.com/skodnik/platformaofd-api-client)[ Packagist](https://packagist.org/packages/vlsv/platformaofd-api-client)[ RSS](/packages/vlsv-platformaofd-api-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (5)Used By (0)

[![workflow](https://github.com/skodnik/platformaofd-api-client/actions/workflows/main.yml/badge.svg)](https://github.com/skodnik/platformaofd-api-client/actions/workflows/main.yml/badge.svg)

Клиент для работы с PlatformaOFD Client API
===========================================

[](#клиент-для-работы-с-platformaofd-client-api)

PlatformaOFD Client API — программный интерфейс для получения информации о кассах пользователя и работы с документами данных касс.

Возможности:
------------

[](#возможности)

С помощью данного клиента пользователь может получать следующую информацию:

- **Кассы** - список касс, зарегистрированных в личном кабинете «Платформы ОФД»;
- **Документы кассы** - список всех документов кассы за период;
- **Отчеты о закрытии смены** - отчеты о закрытии смены кассы (Z-отчетов) за период;
- **Чеки** - кассовые чеки (БСО), чеки (БСО) коррекции кассы за период;
- **Чеки с тегом 1084** - выборка кассовых чеков по значению из тегов 1084, либо с заполненным тегом 1084, либо поиск кассового чека (БСО), чек (БСО) коррекции с определенным значением тега 1084.

Зависимости
-----------

[](#зависимости)

Для выполнения запросов к API используются токены. Предоставление значения осуществляется оператором фискальных данных в индивидуальном порядке.

Установка библиотеки
--------------------

[](#установка-библиотеки)

```
composer require vlsv/platformaofd-api-client
```

Работа с API
------------

[](#работа-с-api)

Пример конфигурации клиента смотри в [TestCaseBase.php](tests/TestCaseBase.php)

### Получение списка Касс

[](#получение-списка-касс)

```
try {
    /** @var \Platformaofd\ClientApi\Model\ResponseKktList $responseKktList */
    $responseKktList = $this->apiClient->sendRequest(
        token: 'access_token',
        apiEndpoint: \Platformaofd\ClientApi\Model\ApiEndpoint::KKTS,
    );
} catch (ApiException $exception) {
    echo $exception->getMessage();

    exit();
}
```

Все методы объекта ответа см. [ResponseKktList](src/Model/ResponseKktList.php)

### Получение Документов кассы

[](#получение-документов-кассы)

```
$dateFrom = new DateTimeImmutable('2023-05-06 10:00:00');
$dateTo = new DateTimeImmutable('2023-06-06 10:00:00');
$requestDocuments = (new \Platformaofd\ClientApi\Model\RequestDocuments())
    ->setRnm('0000000123456789')
    ->setDateFrom($dateFrom)
    ->setDateTo($dateTo);

try {
    /** @var \Platformaofd\ClientApi\Model\ResponseDocuments $responseDocuments */
    $responseDocuments = $this->apiClient->sendRequest(
        token: 'access_token',
        apiEndpoint: \Platformaofd\ClientApi\Model\ApiEndpoint::ALL_DOCUMENTS,
        requestObject: $requestDocuments
    );
} catch (ApiException $exception) {
    echo $exception->getMessage();

    exit();
}
```

Все методы объекта ответа см. [ResponseDocuments](src/Model/ResponseDocuments.php)

### Получение Чеков с тегом 1084

[](#получение-чеков-с-тегом-1084)

```
$receiptDate = new DateTimeImmutable('2023-05-06 10:00:00');
$requestReceiptsWithTag1084 = (new \Platformaofd\ClientApi\Model\RequestReceiptsWithTag1084())
    ->setReceiptDate($receiptDate)
    ->setKktRegIds(['0000000000000000', '0000000000000001'])
    ->setProperties1084(['значение1', 'значение2']);

try {
    /** @var \Platformaofd\ClientApi\Model\ResponseReceiptsWithTag1084 $responseReceiptsWithTag1084 */
    $responseReceiptsWithTag1084 = $this->apiClient->sendRequest(
        token: 'access_token',
        apiEndpoint: \Platformaofd\ClientApi\Model\ApiEndpoint::WITH_TAG1084,
        requestObject: $requestReceiptsWithTag1084
    );
} catch (ApiException $exception) {
    echo $exception->getMessage();

    exit();
}
```

Все методы объекта ответа см. [ResponseReceiptsWithTag1084](src/Model/ResponseReceiptsWithTag1084.php)

Работа с остальными методами производится аналогичным образом.

Debug
-----

[](#debug)

Для отладки можно использовать debug режим с сохранением запросов и ответов. Для этого при создании клиента в конфигурации следует это определить. В интеграционных тестах опция определяется переменной конфига phpunit. Запросы сохраняются в файл `.http`, его можно использовать в дальнейшем для отладки в IDE, например, в PhpStorm. По умолчанию режим выключен.

Тесты
-----

[](#тесты)

```
composer tests-feature
```

Источники
---------

[](#источники)

- [PlatformaOFD Client API](https://docs.google.com/document/d/1CxPzFKaBG4Ox7wlSrZoAAiOMGc6lhj4lgpw-zJpEFWM/edit#)

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance46

Moderate activity, may be stable

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 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 ~55 days

Total

4

Last Release

401d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0a2237c67741e5be893af5ebbcf4fdf0eac507ebb6cea1882a39770891aff07a?d=identicon)[vlsv](/maintainers/vlsv)

---

Top Contributors

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

###  Code Quality

TestsPHPUnit

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/vlsv-platformaofd-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/vlsv-platformaofd-api-client/health.svg)](https://phpackages.com/packages/vlsv-platformaofd-api-client)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

19562.3M1.3k](/packages/drupal-core)[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6939.5M343](/packages/drupal-core-recommended)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)

PHPackages © 2026

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