Введение

Это официальная документация REST API Kroncl — платформы операционного учёта малого бизнеса. С помощью методов, описываемых здесь, вы получаете возможность интегрировать любую функциональность платформы в свои собственные продукты, включая, но не ограничиваясь:

• собственные интернет-магазины;
• формы обратной связи;
• всевозможные боты (Telegram, Discord);
• мобильные приложения;
• плагины для CMS;
• системы аналитики и дашборды.

В последующих статьях этой документации мы осветим аспекты стандартизации API, авторизации, архитектуры и, разумеется, методы модулей с подробным описанием всех сущностей. Мы пишем для разработчиков, поэтому будем использовать JSON-schema и Mermaid-блоки для описания большинства функционала. Если вас интересует исключительно бизнес-составляющая Kroncl, ознакомьтесь с документацией для клиентов.

Как вызывать?

Все методы API строятся по формуле: BASE_URL + METHOD_PATH

BASE_URL постоянный и всегда один:

Для начала работы с API, создайте новое приложение на странице управления приложениями, получите ключ и ознакомьтесь с главой «Авторизация».

Возможности

Это краткий список возможностей, доступных через API Kroncl:

• создание и настройка организаций с выбором тарифного плана;
• управление несколькими организациями из одного аккаунта без перелогина;
• получение сводки по организации: баланс, остатки, активность, количество сотрудников;
• управление сотрудниками: создание карточек, назначение на должности, активация и деактивация;
• создание должностей с гибкой настройкой разрешений;
• привязка аккаунтов платформы к картам сотрудников;
• приглашение новых участников в организацию по email;
• управление разрешениями участников на уровне отдельных действий;
• просмотр и настройка тарифного плана организации;
• просмотр и отмена биллинговых транзакций;
• миграция между тарифными планами с сохранением данных;
• создание, просмотр и сторнирование финансовых операций;
• управление категориями доходов и расходов;
• анализ финансов: сводка, группировка по дням, сотрудникам, категориям;
• прогнозирование баланса организации методом Theta с визуализацией графика;
• ведение базы контрагентов: создание, редактирование, активация и деактивация;
• учёт долговых обязательств: кредиты и дебеты с историей платежей;
• управление клиентской базой: создание клиентов, привязка к источникам привлечения;
• управление источниками привлечения клиентов;
• анализ клиентской базы: сводка, группировка по источникам;
• ведение каталога товаров и услуг: категории и товарные позиции;
• складской учёт: поставки, отгрузки, партионный учёт;
• просмотр складских остатков и движения товаров;
• управление сделками: создание, перемещение по статусам, назначение ответственных;
• формирование состава сделки из каталога и складских партий;
• генерация накладных по сделке с настраиваемыми реквизитами;
• просмотр финансовой истории сделки и финального расчёта;
• анализ сделок: сводка, группировка по сотрудникам, типам, клиентам;
• просмотр логов активности организации с фильтрацией по датам;
• оптимизация и очистка логов для освобождения хранилища;
• управление файловым хранилищем организации: загрузка, скачивание, удаление файлов;
• просмотр использования базы данных и файлового хранилища;
• генерация отчётов по модулям в формате PDF и Excel;
• управление тикетами поддержки: создание, переписка, отслеживание статуса;
• просмотр и настройка документооборота: реквизиты для накладных, брендирование;
• управление API-ключами для программного доступа к платформе;
• управление fingerprint-ключами для быстрой авторизации без пароля;
• получение публичной визитной карточки организации;
• проверка уникальности email и slug компании при регистрации;
• управление партнёрским статусом аккаунта;
• получение списка тарифных планов и их описаний;
• получение полного списка разрешений платформы;
• мониторинг состояния системы и биллинга через статус-эндпоинты;
• всё это — через единый REST API с предсказуемой структурой ответов.

Создано с заботой. Команда Kroncl.