API (Application Programming Interface) — это инструмент, который позволяет ERP Цеховик автоматически обмениваться данными с другими программами и сервисами.
С помощью API можно интегрировать систему с интернет-магазином, CRM, корпоративными сервисами, мобильными приложениями, BI-системами и другими решениями. Благодаря этому данные передаются автоматически, без ручного импорта и экспорта файлов.
Какие задачи решает API #
API позволяет автоматизировать многие процессы, которые раньше приходилось выполнять вручную.
Например, с его помощью можно:
- получать данные из ERP Цеховик во внешние системы;
- автоматически создавать заказы покупателей;
- синхронизировать клиентов и справочники;
- обмениваться данными со складскими системами;
- интегрировать ERP с интернет-магазином;
- передавать информацию в BI-системы для построения аналитики;
- связывать ERP с собственными корпоративными сервисами.
Использование API позволяет сократить количество ручной работы и снизить вероятность ошибок при передаче данных.
Какие данные доступны через API #
API предоставляет доступ практически ко всем основным разделам ERP Цеховик.
В том числе можно работать с:
- заказами покупателей;
- счетами и отгрузками;
- заказами поставщикам;
- приемками и возвратами;
- платежами;
- технологическими картами;
- материалами;
- изделиями;
- деталями;
- контрагентами;
- складами;
- производственными участками;
- операциями;
- справочниками и другими объектами системы.
По каждому разделу доступны операции просмотра, создания, изменения и удаления данных (в зависимости от предоставленных прав доступа).
Как начать работу с API #
Для использования API потребуется:
- Проверить доступность API в вашем тарифе.
- Создать OAuth-клиент для интеграции.
- Получить данные для подключения.
- Передать их разработчику или компании, которая будет выполнять интеграцию.
После этого разработчик сможет настроить безопасный обмен данными между ERP Цеховик и внешней системой.
Безопасность #
API использует современный механизм авторизации OAuth 2.0. Для каждой интеграции создаются собственные данные доступа, а права можно ограничить только теми разделами системы, которые действительно необходимы для работы.
Такой подход позволяет обеспечить безопасный обмен данными без предоставления полного доступа к учетной записи.
Где посмотреть список доступных методов #
Для разработчиков подготовлена отдельная документация API.
В ней содержится информация о:
- доступных методах;
- параметрах запросов;
- структуре передаваемых данных;
- возможных ответах сервера;
- правилах авторизации.
Эта документация предназначена для специалистов, которые будут выполнять интеграцию.
Когда стоит использовать API #
API рекомендуется использовать, если необходимо регулярно обмениваться данными между ERP Цеховик и другими информационными системами.
Например, если:
- компания использует интернет-магазин;
- необходимо автоматически создавать документы;
- требуется синхронизация с CRM;
- используются собственные программы или мобильные приложения;
- нужна автоматическая выгрузка данных для аналитики.
Если обмен выполняется редко или однократно, удобнее воспользоваться встроенными функциями импорта и экспорта данных.
Если вы не уверены, подойдет ли API для вашей задачи или хотите подключить интеграцию, обратитесь в поддержку ERP Цеховик. Мы поможем определить оптимальный способ обмена данными и ответим на вопросы по настройке API.