Download the PHP package produman-org/kassa-php without Composer
On this page you can find all versions of the php package produman-org/kassa-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download produman-org/kassa-php
More information about produman-org/kassa-php
Files in produman-org/kassa-php
Package kassa-php
Short Description PHP library for the Produman.Kassa API
License MIT
Informations about the package kassa-php
Produman API PHP Client Library
Клиент для работы с онлайн кассой Продуман по API
Содержание
- Требования
- Установка
- Порядок работы с клиентом
- Примеры использования основных API методов
- Инициализация клиента
- Справочник касс
- Справочник категорий внесений и выплат
- Справочник контрагентов
- Справочник сотрудников
- Работа с операциями
- Работа с заказами
- Примеры использования сервисных API методов
- Инициализация клиента сервисных запросов
- Вебхуки
- Интеграции
- Примеры работы с исключениями
- Примеры использования RateLimit
Требования
PHP 7.4.0 (и выше) с расширениями json и curl
Установка
В консоли с помощью Composer
- Установите менеджер пакетов Composer.
- В консоли выполните команду
В файле composer.json своего проекта
-
Добавьте строку
"produman-org/kassa-php": "^1.0"
в список зависимостей вашего проекта в файле composer.json -
Обновите зависимости проекта. В консоли перейдите в каталог, где лежит composer.json, и выполните команду:
- В коде вашего проекта подключите автозагрузку файлов нашего клиента:
Порядок работы с клиентом
-
Для основных API запросов (справочники, операции или заказы) создайте экземпляр объекта клиента при помощи команды
buildClient
, задайте клиентский токен, идентификатор приложения и секретный ключ (их можно получить в личном кабинете Продуман). -
Для сервисных API запросов (вебхуки и интеграции) создайте экземпляр объекта клиента при помощи команды
buildApplicationClient
(аналогично, как в примере выше, но без указанияclientToken
). -
Дополнительно, при создании клиента, можно скорректировать параметр
timeout
для curl запросов, использовать логгерPsr\Log\LoggerInterface
в параметреlogger
, а так же указать передачу заголовкаAccept-Language
в параметреlanguage
. -
Вызовите нужный метод API в объекте
$client
. -
Для каждого API запроса клиент содержит в себе соответствующий метод. Методы, если требуется, в качестве параметра принимают объекты классов запросов
ProdumanApi\Request\...
. В качестве ответа, методы возвращают объекты классов ответовProdumanApi\Response\...
. -
Дополнительно имеется поддержка исключений
ProdumanApi\Exception\...
. Например, исключениеProdumanApi\Exception\ApiException
используется для вывода данных, описанных в разделе обработка ошибок API. - В API Продуман имеются ограничения на количество и частоту запросов RateLimit. Для получения информации о текущем лимите в объекте клиента имеются соответствующие методы.
Примеры использования основных API методов
1. Инициализация клиента
2. Справочник касс
3. Справочник категорий внесений и выплат
4. Справочник контрагентов
5. Справочник сотрудников
6. Работа с операциями
7. Работа с заказами
Примеры использования сервисных API методов
1. Инициализация клиента сервисных запросов
2. Вебхуки
3. Интеграции
Примеры работы с исключениями
Примеры использования RateLimit
Наверх
All versions of kassa-php with dependencies
ext-json Version *
ext-curl Version *
psr/log Version ^1|^2|^3
symfony/http-client Version ^5.4|^6.0|^7.0