business-ru/ofd-api-sdk-php

SDK для работы с OFD API

1.0.2 2023-04-17 16:49 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-json: *
• monolog/monolog: ^2.6
• psr/log: ^1.0
• psr/simple-cache: ^1.0
• symfony/http-client: ^5.3

proprietary

• Alexandr Nikitin

README

О проекте

Данная библиотека предназначена для работы с сервисом ОФД-Я.

Требования

• PHP 7.4 и выше
• PHP extension cURL

Установка

composer require business-ru/ofd-api-sdk-php

Документация: https://ofd-ya.ru/docs/API_OFD_YA.pdf

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

Добавляем в .env

OFD_TOKEN = Токен

Пример использования

/**
* Инициализируем класс
* @var OfdClient|null
*/
private ?OfdClient $ofdClient = null;

/**
* Общий метод, для любой модели
* Метод позволяет выполнить запрос к API OFD
* Для ofd-api-sdk-php
* @param string $method - Наименование метода
* @param string $model - Наименование модели
* @param array<array> $params - Параметры запроса
* @return int|mixed|string[]
* @throws \JsonException
* @throws ClientExceptionInterface
* @throws DecodingExceptionInterface
* @throws RedirectionExceptionInterface
* @throws ServerExceptionInterface
* @throws TransportExceptionInterface
*/
public function ofdApiRequest(string $method, string $model, array $params = [])
{
	$this->ofdClient = new OfdClient();
	$this->response = $this->ofdClient->request(strtoupper($method), $model, $params);
	return $this->response;
}

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

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

ОФД	Оператор Фискальных Данных	Сервис принимающий с кассого аппарата данные о выбитых чеках и передающий их в налоговую службу.
ККТ	Контрольно Кассовая Техника	Кассовый аппарат выбивающий чеки либо на бумаге либо в электронном виде.
ККМ	Контрольно Кассовая Машина	Устаревшее название ККТ.
ФД	Фискальный Документ	Документ отправляемый в налоговую службу. Кассовый чек является частным случаем ФД.
ФФД	Формат Фискальных Данных	По сути спецификация описывающая свойства (реквизиты) и их значения которые могут быть у ФД.
Тег ФД	-	По сути имя свойства (реквизита) ФД которые передаются в ОФД. Например, в теге 1037 касса передает свой регистрационный номер.