This repository contains the OpenAPI 3.1.0 specification for the SmartKasa API - a Ukrainian fiscal cash register and point-of-sale management system.
SmartKasa provides a comprehensive REST API for managing:
- Authentication - User sessions and authorization
- Terminals - POS terminal configuration and management
- Shops - Retail location management
- Employees - Staff and permissions management
- Units of Measure - Reference data for product units
- Categories - Product catalog categories
- Products - Product catalog and pricing
- Inventory Cards - Stock tracking and management
- Product Subgroups - Product classification
- Import - Batch operations for products and categories
- Shifts - Fiscal and trade shifts management
- POS Operations - Receipts, payments, and transactions
- Reports - Sales reports, X-reports, and Z-reports
https://core.smartkasa.ua
The API uses API Key authentication:
- API Key (
X-API-KEYheader) - Required for all requests
For requests that require user authorization, an additional Authorization header must be present (obtained via /api/v1/auth/sessions).
- JSON:
openapi.json - YAML:
openapi.yaml
- Total Endpoints: 56
- API Version: 1.0.18
- OpenAPI Version: 3.1.0
This specification is also available in API Blueprint format.
This OpenAPI specification is provided for integration and development purposes. Please refer to SmartKasa API Integration Rules for API usage policies.
Цей репозиторій містить OpenAPI 3.1.0 специфікацію для SmartKasa API - української системи управління фіскальними касовими апаратами та точками продажу.
SmartKasa надає комплексний REST API для управління:
- Авторизація - Сесії користувачів та авторизація
- Термінали - Налаштування та управління POS терміналами
- Торгові точки - Управління локаціями роздрібної торгівлі
- Працівники - Управління персоналом та правами доступу
- Одиниці виміру - Довідник одиниць виміру товарів
- Каталоги - Категорії товарів
- Товари - Каталог товарів та ціни
- Облік товарів - Облік та управління запасами
- Товарні підгрупи - Класифікація товарів
- Імпорт - Масові операції з товарами та категоріями
- Зміни - Управління фіскальними та торговими змінами
- POS операції - Чеки, платежі та транзакції
- Звіти - Звіти про продажі, X-звіти та Z-звіти
https://core.smartkasa.ua
API використовує аутентифікацію через API Key:
- API Key (заголовок
X-API-KEY) - Обов'язковий для всіх запитів
Для запитів які потребують авторизації користувача повинен бути наявним додатково заголовок Authorization (отримується через /api/v1/auth/sessions).
- JSON:
openapi.json - YAML:
openapi.yaml
- Всього Endpoints: 56
- Версія API: 1.0.18
- Версія OpenAPI: 3.1.0
Також ця специфікація доступна в форматі API Blueprint.
Ця OpenAPI специфікація надається для цілей інтеграції та розробки. Будь ласка, зверніться до Правил інтеграції SmartKasa API щодо політики використання API.