PHPackages bigperson/modulpos-php-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. bigperson/modulpos-php-api-client ActiveLibrary bigperson/modulpos-php-api-client ================================= PHP client for modulpos API Fiscal Service 2.1.1(5y ago)171.8k10[6 issues](https://github.com/bigperson/modulpos-php-api-client/issues)[3 PRs](https://github.com/bigperson/modulpos-php-api-client/pulls)1MITPHPPHP ^7.1CI failing Since Jul 25Pushed 5y ago2 watchersCompare [ Source](https://github.com/bigperson/modulpos-php-api-client)[ Packagist](https://packagist.org/packages/bigperson/modulpos-php-api-client)[ RSS](/packages/bigperson-modulpos-php-api-client/feed)WikiDiscussions master Synced 3d ago READMEChangelog (7)Dependencies (2)Versions (8)Used By (1) PHP клиент для API автоматической фискализации чеков интернет-магазинов Модуль.Кассы ==================================================================================== [](#php-клиент-для-api-автоматической-фискализации-чеков-интернет-магазинов-модулькассы) [![](https://camo.githubusercontent.com/d5b2b5652b721fc1f9584f9c32923ebe9db92dcfe096017eac93ec84a4e17182/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f626967706572736f6e2f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://github.com/bigperson/modulpos-php-api-client/blob/master/LICENSE)[![](https://camo.githubusercontent.com/df390fa99ca081ae367767590cb1da2033e7ecead4ad6818cb8ae530286149cf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f626967706572736f6e2f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bigperson/modulpos-php-api-client)[![](https://camo.githubusercontent.com/22cc06b726901771b424a3b4c89c8d96584e66c8bb871cfedf4859a70c9b6e73/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f626967706572736f6e2f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bigperson/modulpos-php-api-client)[![](https://camo.githubusercontent.com/06e28c80d8b36c52cdaf1c398233decbbb4141891da67268b34580de22e320de/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f626967706572736f6e2f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/bigperson/modulpos-php-api-client)[![](https://camo.githubusercontent.com/dc95d8cc86aba4f567c03bceb61526755ea518fe22898dfe4de2dbe0e9091b32/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f626967706572736f6e2f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://codecov.io/gh/bigperson/modulpos-php-api-client)[![StyleCI](https://camo.githubusercontent.com/da8202f0cfa2a4b25934f8f43de39232002b6d49dffe03334696615a774633fa/68747470733a2f2f7374796c6563692e696f2f7265706f732f39383330363835312f736869656c643f6272616e63683d6d6173746572)](https://styleci.io/repos/98306851) Пакет предоставляет удобный интерфейс для общения с API Модуль.Кассы для отправки данных чеков в сервис фискализации. Пакет упрощает разработку модулей интеграции интернет-магазина с севисом фискализации Модуль.Кассы. Часть описания дублирует оригинал [документации по API Модуль.Кассы](http://modulkassa.ru/upload/medialibrary/abb/api-avtomaticheskoy-fiskalizatsii-chekov-internet_magazinov-_ver.1.2_.pdf) Требования ---------- [](#требования) - php ^7.1 - guzzlehttp/guzzle (или любой клиент следующий интерфейсу `\GuzzleHttp\ClientInterface`) - ext-json - curl Установка --------- [](#установка) Вы можете установить данный пакет с помощью сomposer: ``` composer require bigperson/modulpos-php-api-client ``` Для PHP 5.4-7.0 можеете использовать предыдущую версию ``` composer require bigperson/modulpos-php-api-client 1.0 ``` Использование ------------- [](#использование) Схема процесса фискализации подробна описана в [документации к API](https://support.modulkassa.ru/upload/medialibrary/abb/API%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B9%20%D1%84%D0%B8%D1%81%D0%BA%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8%20%D1%87%D0%B5%D0%BA%D0%BE%D0%B2%20%D0%B8%D0%BD%D1%82%D0%B5%D1%80%D0%BD%D0%B5%D1%82-%D0%BC%D0%B0%D0%B3%D0%B0%D0%B7%D0%B8%D0%BD%D0%BE%D0%B2%20(ver.1.4).pdf). В кратце необходимо связать точку продаж с интернет магазином, настроить отправку данных чеков и проверить статус отправленного чека. ### Создания связки аккаунта и розничной точки [](#создания-связки-аккаунта-и-розничной-точки) Для начала необходимо в личном кабинете Модуль.Кассы создать розничную точку продаж, активировать у неё функцию `Использовать для печати документов интернет-магазина` и получить идентификатор `uuid`. Далее вызываем связку ``` $login = 'test@test.ru'; // Логин от аккаунта Модуль.Кассы $password = 'password'; // Пароль от аккаунта Модуль.Кассы $retailPointUuid = 'uuid'; // Идентификатор розничной точки $testMode = true; // Тестовый режим $associate = new \Bigperson\ModulposApiClient\Associate($login, $password, $retailPointUuid, $testMode); $result = $associate->init(); ``` В `$result` получим массив с данным `userName` и `password` которые будут использоватся для дальнейших обращений к API. Их нужно где-нибудь сохранить, например в базе данных. ### Отправка данных чека на сервер фискализации (создание документа) [](#отправка-данных-чека-на-сервер-фискализации-создание-документа) Для начала необходимо сформировать данные самого чека. Для этого достаточно для ваших моделей инплементировать интерфейсы ModulposOrderInterface для заказа, ModulposOrderItemInterface для товара в заказе, ModulposPaymentItemInterface для способа оплаты. Также вы можете использовать entity из пакета, или отнаследовать от них собственные классы переопределив методы на собственные. ``` use Bigperson\ModulposApiClient\Entity\Order; use Bigperson\ModulposApiClient\Entity\Cashier; use Bigperson\ModulposApiClient\Entity\OrderItem; use Bigperson\ModulposApiClient\Entity\PaymentItem; $dateTime = new \DateTime('NOW'); // Создаем заказ $order = Order::create([ 'documentUuid' => uniqid(), 'checkoutDateTime' => $dateTime->format(DATE_RFC3339), 'orderId' => rand(100000, 999999), 'typeOperation' => 'SALE', 'customerContact' => 'test@example.com', ]); // Созадем товары $orderItem1 = OrderItem::create([ 'price' => 100, 'quantity' => 1, 'vatTag' => OrderItem::VAT_NO, 'name' => 'Test Product1' ]); $orderItem2 = OrderItem::create([ 'price' => 200, 'quantity' => 1, 'vatTag' => OrderItem::VAT_NO, 'name' => 'Test Product2' ]); //Создаем способ оплаты $paymentItem = PaymentItem::create([ 'type' => 'CARD', 'sum' => 300 ]); // Добавляем товары и способ оплаты к заказу $order->addItem($orderItem1); $order->addItem($orderItem2); $order->addPaymentItem($paymentItem); //Создаем кассира $cashier = Cashier::create([ 'name' => 'Test Cashier', 'inn' => '123456789012', 'position' => 'salesman', ]); ``` Далее объект заказа необходимо передать клиенту, также вы можете передать `responseURL` и печатать ли чек на кассе: ``` $login = 'test@test.ru'; // Логин полученный на первом шаге $password = 'password'; // Пароль полученный на первом шаге $testMode = true; // Тестовый режим $client = new \Bigperson\ModulposApiClient\Client($login, $password, $testMode); $responseUrl = 'https://internet.shop.ru/order/982340931/checkout?completed=1'; $printReceipt = true; // Печатать ли чек на кассе $result = $client->sendCheck($order, $responseUrl, $printReceipt, $cashier); ``` Все параметры кроме $order - опциональные. Если не передан объект `ModulposCashierInterface`то будут использованны данные из настроек торговой точки. В ответ придет массив со статусом обработки документа и фискального накопителя. ### Проверка статуса документа [](#проверка-статуса-документа) Если при передаче данных чека был передан `responseURL`, то на него придет результат фискализации, если параметр задан не был, то вы можете самостоятельно проверить статус документа: ``` $login = 'test@test.ru'; // Логин полученный на первом шаге $password = 'password'; // Пароль полученный на первом шаге $testMode = true; // Тестовый режим $documentId = 'efbafcdd-113a-45db-8fb9-718b1fdc3524'; // id документа $client = new \Bigperson\ModulposApiClient\Client($login, $password, $testMode); $result = $client->getStatusDocumentById($documentId); ``` В ответ придет массив со статусом `status`, который может принимать значения: - QUEUED - документ принят в очередь на обработку; - PENDING - документ получен кассой для печати; - PRINTED - фискализирован успешно; - COMPLETED - результат фискализации отправлен (если было заполнено поле responseURL) в сервис источник; - FAILED - ошибка при фискализации. Также в массив придет `fnState` - статус фискального накопителя, может принимать значения: - ready ​- соединение с фискальным накопителем установлено, состояние позволяет фискализировать чеки - associated​ - клиент успешно связан с розничной точкой, но касса еще ни разу не вышла на связь и не сообщила свое состояние - failed ​- Проблемы получения статуса фискального накопителя. Этот статус не препятствует добавлению документов для фискализации. Все документы будут добавлены в очередь на сервере и дождутся момента когда касса будет в состоянии их фискализировать Кроме того вы можете вызвать отдельно метод проверки статуса фискального накопителя (сервиса фискализации): ``` $client = new \Bigperson\ModulposApiClient\Client($login, $password, $testMode); $result = $client->getStatusFiscalService(); ``` Развитие пакета --------------- [](#развитие-пакета) С целью активного развития пакета, рекомендуем создавать пулл-реквесты, а не только баг-репорты ([issues](https://github.com/bigperson/modulpos-php-api-client/issues)). По любым проблемам рекомендуем открывать Баг-репорты с подробным описанием проблемы и последовательностью действия для воспроизведения бага. Лицензия -------- [](#лицензия) [MIT](https://raw.githubusercontent.com/bigperson/modulpos-php-api-client/master/LICENSE) ### Health Score 33 — LowBetter than 75% of packages Maintenance13 Infrequent updates — may be unmaintained Popularity26 Limited adoption so far Community18 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 82.6% 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 ~253 days Recently: every ~316 days Total 6 Last Release 1948d ago Major Versions 0.0.2 → 1.0.12019-01-21 1.0.1 → 2.0.02019-06-17 PHP version history (2 changes)0.0.1PHP ^5.4 2.0.0PHP ^7.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/4d5dccbd021fd3882613034b49a5d0d6726d5a16a0224e99b5359d6058719265?d=identicon)[bigperson](/maintainers/bigperson) --- Top Contributors [![bigperson](https://avatars.githubusercontent.com/u/4757391?v=4)](https://github.com/bigperson "bigperson (19 commits)")[![VampiRUS](https://avatars.githubusercontent.com/u/433120?v=4)](https://github.com/VampiRUS "VampiRUS (2 commits)")[![Bessamu](https://avatars.githubusercontent.com/u/36696244?v=4)](https://github.com/Bessamu "Bessamu (1 commits)")[![re8us](https://avatars.githubusercontent.com/u/4831984?v=4)](https://github.com/re8us "re8us (1 commits)") --- Tags fz54modulbankmodulkassamodulposonline-kassaphp-apiphp-client ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/bigperson-modulpos-php-api-client/health.svg) ``` [![Health](https://phpackages.com/badges/bigperson-modulpos-php-api-client/health.svg)](https://phpackages.com/packages/bigperson-modulpos-php-api-client) ``` ### Alternatives [neuron-core/neuron-ai The PHP Agentic Framework. 1.8k245.3k21](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)