README

Библиотека предоставляет унифицированный интерфейс (см. ProviderInterface) работы с различными ОФД (оператор фискальных данных) при получении данных о фискальных документах (чеках).

Основная цель - облегчить интеграцию проекта при работе с разными API операторов. Например, при синхронизации данных о выбитых на кассе чеках и данных ушедших в налоговую.

Поддерживаемые ОФД

• ООО «Такском»
• ООО «Яндекс.ОФД»

Установка

Через composer командой: composer require alekciy/php-ofd-sdk

Пример

Ниже приведен пример работы для Такском и Яндекс.ОФД.

<?php

include_once __DIR__ . '/vendor/autoload.php';

use alekciy\ofd\providers\taxcom\Client as TaxcomClient;
use alekciy\ofd\providers\taxcom\Credentials as TaxcomCredentials;
use alekciy\ofd\providers\taxcom\Taxcom;
use alekciy\ofd\providers\yandex\Client as YandexClient;
use alekciy\ofd\providers\yandex\Credentials as YandexCredentials;
use alekciy\ofd\providers\yandex\Yandex;

// ============ Инициализация клиента ============
// У каждого провайдера свои требование при работе через API поэтому инициализация клиента
// зависит от используемого провайдера.

// Инициализируем Такском API клиент
$credentials = new TaxcomCredentials(
	'api-lk-ofd.taxcom.ru',
	'логин',
	'пароль',
	'токен'
);
$agreementNumber = 'Номер договора';
$client = new TaxcomClient($credentials, $agreementNumber);
$taxcom = new Taxcom($client);

// Инициализация Яндекс.ОФД клиент
$credentials = new YandexCredentials(
	'api.ofd.yandex.net',
	'аутентификационный ключ',
	'авторизационный ключ'
);
$client = new YandexClient($credentials);
$yandex = new Yandex($client);

// ============ Получение данных ============
// Получаем список точек продаж с Такском...
$outletList = $taxcom->getOutletList();
$outlet = current($outletList);
// ...список касс с первой точки...
$cashDeskList = $taxcom->getCashDeskList($outlet);
$cashDesk = current($cashDeskList);
// ...и список смен с первой кассы
$shiftList = $taxcom->getShiftList($cashDesk);

// Получение смен через Яндекс.ОФД выглядит точно так же
$outletList = $yandex->getOutletList();
$outlet = current($outletList);
$cashDeskList = $taxcom->getCashDeskList($outlet);
$cashDesk = current($cashDeskList);
$shiftList = $taxcom->getShiftList($cashDesk);

Тесты

В библиотеке используются два вида тестов:

• юнит для проверки правильности работы самой библиотеки;
• интеграционные для проверки работы API заданного ОФД.

Юнит тесты

Для запуска тестов нужно:

1. выполнить командуcomposer test-unit.

Интеграционные тесты

Для запуска тестов нужно:

1. скопировать файл нужного ОФД (например, taxcom) tests/credentials/ОФД.example.php в файл tests/credentials/ОФД.php;
2. вписать требуемые реквизиты доступа в tests/credentials/ОФД.php;
3. выполнить команду composer test-integration-ОФД.

Основные термины

В таблице приведены термины в порядке удобном для понимания.