Fullio Client API

Документация server-to-server API Fullio для сервиса, реализующего личный кабинет компании-клиента.

API работает через JSON-RPC 2.0. Компания определяется по API-ключу, который должен храниться только на backend сервиса личного кабинета.

Статус

Версия документации: 0.2.0-draft.

Документация описывает проектируемый контракт будущего рабочего API. Наличие метода в документации не означает, что он уже реализован в Fullio.

Разделы

1. Общие правила
2. Dashboard
3. Товары
4. Остатки и движения
5. Поставки
6. Заказы
7. Тикеты
8. Файлы
9. Возвраты
10. Биллинг
11. Webhooks

Что не входит в контракт

• юридический раздел документов;
• управление интеграциями и API-ключами;
• настройка URL и секрета webhook через клиентский API;
• настройки компании, пользователей и ролей;
• внутренние складские методы ТСД и backend Fullio.

Реализованный API

Рабочий контракт находится в разделе API личного кабинета компании (/company-{companyId}/api). Реализованные и документированные части удаляются из этого проекта. Здесь остаются будущие требования; наличие текста не означает наличия соответствующего метода. Нереализованные остатки не удаляются без решения.

Правило изменения документации

Каждый метод полностью описывается в одном предметном разделе: назначение, параметры, результат, ограничения, ошибки и законченный пример. Общие структуры и правила не дублируются, а берутся из раздела «Общие правила».