API для разработчиков

Данные без шума.
Простые решения для вашего кода.

RESTful API для глубокой интеграции с ИконКит. Получайте данные о продажах, остатках и клиентах в реальном времени. Документация, SDK и песочница для тестов.

Открыть документацию → Смотреть SDK
GET
/api/v1/analytics/sales
Authorization: Bearer sk_live_8f7...

{

  "status": "success",
  "data": {
    "revenue": 145200.50,
    "currency": "RUB"
  }
Обзор

Единый интерфейс для всех данных

API ИконКит спроектировано по принципам REST. Мы используем стандартные HTTP-методы, JSON для тела запросов и ответов, а также коды состояния для индикации ошибок.

⚡

Низкая задержка

Среднее время ответа — 120 мс. Данные о продажах попадают в базу менее чем через секунду после сканирования штрих-кода на кассе.

🔗

Webhooks

Подпишитесь на события: `sale.created`, `inventory.low`, `customer.returned`. Ваш сервер получит уведомление мгновенно.

🛡️

Безопасность

OAuth 2.0, шифрование TLS 1.3 и IP-белые списки. Ваши данные защищены на каждом уровне передачи и хранения.

Авторизация

Как получить доступ

Мы используем Bearer-токены для аутентификации. Получите ключ в личном кабинете в разделе «Настройки API».

1

Генерация ключа

Зайдите в icookit.com/settings/api. Нажмите «Создать токен». Сохраните его сразу — повторно отобразить его нельзя.

2

Передача в заголовке

Добавляйте токен в заголовок каждого запроса. Не передавайте его в URL-параметрах.

Authorization: Bearer YOUR_API_KEY
Эндпоинты

Основные ресурсы

Полный список методов доступен в Swagger-документации. Вот самые частые запросы.

GET /v1/sales

Возвращает список транзакций. Поддерживает пагинацию (`limit`, `offset`) и фильтрацию по дате (`from`, `to`).

POST /v1/inventory/items

Создает или обновляет товарную позицию. Требует права `inventory:write`. Возвращает ID созданного товара.

GET /v1/loyalty/customers/:id

Получает данные клиента по ID или номеру телефона. Включает историю покупок и текущий баланс бонусов.

Посмотреть все 42 эндпоинта →
Инструменты

SDK и библиотеки

Не пишите обертки с нуля. Используйте наши официальные пакеты для популярных языков программирования.

JS

Node.js

Обещания (Promises) и TypeScript-типы из коробки. Идеально для Express и NestJS.

npm install @icookit/sdk Скачать
PY

Python

Легкий клиент для Django и FastAPI. Поддержка асинхронных запросов через `asyncio`.

pip install icookit-python Скачать
PHP

PHP

Классическая библиотека для интеграции с Laravel и WordPress. PSR-4 совместимость.

composer require icookit/php Скачать

Нужна помощь с интеграцией?

Наша техническая поддержка отвечает разработчикам в течение 2 часов в рабочее время (Пн-Пт, 10:00–19:00 МСК).

Написать в поддержку Telegram-канал Dev