anthony/atol-online
1
0
Fork 0
mirror of https://github.com/anthonyaxenov/atol-online.git synced 2024-11-22 11:34:33 +00:00
Code Issues Projects Releases Wiki Activity
Зеркало из GitHub. Библиотека для работы с АТОЛ Онлайн (облачная ККТ для приёма платежей по 54-ФЗ). https://packagist.org/packages/axenov/atol-online
57 Commits 3 Branches 21 Tags 575 KiB
PHP 100%
2943d93962
Go to file
AnthonyAxenov 2943d93962 Улучшен класс Company 
* valid_strlen()
* Constraints::MAX_LENGTH_PAYMENT_ADDRESS
* phpdoc
2020-06-07 20:12:23 +08:00
.github Github actions только на мастере 2020-05-28 01:13:08 +08:00
docs Освежил документацию в части работы с объектом Kkt 2020-06-04 22:29:36 +08:00
src Улучшен класс Company 2020-06-07 20:12:23 +08:00
tests Удалёно всё, что связано со схемами 2020-06-07 20:12:22 +08:00
.gitignore Игнор файла-песочницы 2020-04-15 21:40:15 +08:00
composer.json Новый файл helpers 2020-06-07 20:12:22 +08:00
composer.lock Обновления в composer.lock 2020-05-28 01:25:27 +08:00
LICENSE Initial commit, v0.1.0-b 2020-01-11 14:30:25 +08:00
phpunit.xml Initial commit, v0.1.0-b 2020-01-11 14:30:25 +08:00
README.md Бейджик в readme + фикс composer.json 2020-05-28 01:14:53 +08:00
ROADMAP.md Initial commit, v0.1.0-b 2020-01-11 14:30:25 +08:00

README.md

АТОЛ Онлайн

Build

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

Текущая поддерживаемая версия API: 5.1

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

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

  • PHP 7.2+
  • composer
  • php-json

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

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

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

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

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

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

./vendor/bin/phpunit

Настройка ККТ

Для работы с облачной ККТ необходимы следующие параметры:

  • логин;
  • пароль;
  • код группы.

Чтоб получить их, нужно:

  1. авторизоваться на online.atol.ru;
  2. на странице Мои компании нажать кнопку Настройки интегратора.
    Скачается XML-файл с нужными настройками.

Также для работы потребуются:

  • ИНН продавца;
  • URL места расчёта (ссылка на ваш интернет-сервис).

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

Доступные методы и классы

Весь исходный код находится в директории /src.

Комментарии phpDoc есть буквально к каждому классу, методу или полю. Прокомментировано вообще всё.

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

Тогда у вас не возникнет затруднений.

Для тех, кто решил подробно разобраться в работе библиотеки, отдельно отмечу нюансы, которые могут ускользнуть от внимания:

  1. Класс AtolOnline\Api\Kkt унаследован от GuzzleHttp\Client со всеми вытекающими;
  2. Все классы, унаследованные от AtolOnline\Entities\AtolEntity приводятся к JSON-строке.

Общий алгоритм

  1. Задать настройки ККТ
  2. Собрать данные о покупателе
  3. Собрать данные о продавце
  4. Собрать данные о предметах расчёта (товары, услуги и пр.)
  5. Создать документ, добавив в него покупателя, продавца и предметы расчёта
  6. Отправить документ на регистрацию:
    6.1. Необязательно: задать callback_url, на который АТОЛ отправит HTTP POST о состоянии документа.
  7. Запомнить uuid из пришедшего ответа, поскольку он пригодится для последующей проверки статуса фискализации.

    Если с документом был передан callback_url, то ответ придёт на этот самый URL.
    Если с документом НЕ был передан callback_url либо callback от АТОЛа не пришёл в течение 300 секунд (5 минут), нужно запрашивать вручную по uuid, пришедшему от АТОЛа в ответ на регистрацию документа.

  8. Проверить состояние документа (нет необходимости, если передавался callback_url):
    8.1. взять uuid ответа, полученного на запрос фискализации;
    8.2. отправить его в запросе состояния документа.

    Данные о документе можно получить только в течение 32 суток после успешной фискализации.

Об отправке электронного чека покупателю

После успешной фискализации документа покупатель автоматически получит уведомление от ОФД, который используется в связке с вашей ККТ:

  • по email, если в документе указан email клиента;
  • по смс:
    • если в документе указан номер телефона клиента;
    • если на стороне ОФД необходима и подключена услуга СМС-информирования (уточняйте подробности о своего ОФД).

Если заданы email и телефон, то отдаётся приоритет email.

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

Discord-сервер для обсуждения этой библиотеки: discord.gg/mFYTQmp

Функционал, находящийся в разработке: ROADMAP.md

Официальные ресурсы АТОЛ Онлайн:

Лицензия

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