axenov/atol-online

Библиотека для работы с API АТОЛ Онлайн (облачные ККТ для приёма платежей по 54-ФЗ)

v1.0.2 2022-08-13 13:59 UTC

README

Библиотека для фискализации чеков по 54-ФЗ через облачные ККТ АТОЛ.

GitHub Workflow Status (master) codecov Stable Version Packagist PHP Version Support Liberapay License

Документация

Текущие поддерживаемые версии АТОЛ Онлайн:

Протокол API ФФД Статус
v4 5.8 1.05 Поддерживается
v5 2.0 1.2 В планах

Плюшечки

  • Мониторинг ККТ и ФН
  • Фискализация документов на облачной ККТ
  • Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
  • Расчёты денег в копейках
  • PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters, докблоки

Системные требования

  • php v8.0 и выше
  • php-json
  • php-curl
  • php-mbstring
  • php-tokenizer
  • composer

Начало работы

Подключение библиотеки

  1. Подключить пакет к проекту:
    composer require axenov/atol-online
  2. В нужном месте проекта подключить автозагрузчик composer-зависимостей, если это не сделано ранее:
    require($project_root . '/vendor/autoload.php');
    где $project_root — абсолютный путь к корневой директории вашего проекта.

    При использовании фреймворков это обычно не требуется.

Тестирование кода библиотеки

Файлы тестов находятся в директории /tests корня репозитория.

Для запуска тестов необходимо перейти в корень репозитория и выполнить одну из команд:

composer test # обычное тестирование
composer coverage # тестирование с покрытием

После тестирования с покрытием создаётся отчёт в директории .coverage в корне репозитория.

Использование библиотеки

Весь исходный код находится в директории /src. Вы имеете право использовать и распространять его на условиях лицензии MIT.

  1. Обращайтесь к документации библиотеки
  2. Обращайтесь к исходному коду и описанным докблокам
  3. Обращайтесь к тестам
  4. Используйте нормальную IDE

Дополнительные ресурсы

Donate using Liberapay