API (Application Programming Interface) — способ, которым Цеховик обменивается данными с другими программами без ручного импорта и экспорта файлов. Через API Цеховик связывают с интернет-магазином, CRM, складскими и BI-системами, собственными программами компании.
Где найти: Настройки → Интеграции → API для интеграций.
Открытый API доступен не на всех тарифах: какие интеграции и API входят в ваш, смотрите на странице тарифов.
Какие задачи решает API
- получать данные из Цеховика во внешние системы;
- автоматически создавать заказы покупателей;
- синхронизировать клиентов и справочники;
- обмениваться данными со складскими системами;
- связывать Цеховик с интернет-магазином;
- передавать данные в BI-системы для аналитики;
- связывать Цеховик с собственными программами компании.
Какие данные доступны через API
API открывает доступ к основным разделам Цеховика, в том числе к:
- заказам покупателей;
- счетам и отгрузкам;
- заказам поставщикам;
- приемкам и возвратам;
- платежам;
- технологическим картам;
- материалам;
- изделиям;
- деталям;
- контрагентам;
- складам;
- производственным участкам;
- операциям;
- справочникам и другим объектам системы.
С каждым разделом можно выполнять просмотр, создание, изменение и удаление — в пределах прав, выданных приложению.
Как начать работу с API
- Убедитесь, что открытый API входит в ваш тариф (тарифы).
- Создайте приложение API (OAuth-клиент) для интеграции.
- Сохраните данные для подключения.
- Передайте их разработчику или компании, которая делает интеграцию.
Создание приложения API
- Откройте Настройки → Интеграции → API для интеграций.
- Нажмите «Добавить».
- В поле «Наименование» укажите название, по которому вы узнаете приложение, например «1С УНФ».
- Отметьте права доступа приложения (см. «Какие права отметить»).
- Нажмите «Сохранить».
После сохранения Цеховик покажет данные для подключения:
- Идентификатор клиента;
- Секретный ключ;
- Идентификатор аккаунта.
Важно! Секретный ключ показывается один раз, сразу после создания приложения. Сохраните его в надежном месте: после закрытия окна посмотреть ключ еще раз нельзя.
Какие права отметить
Права задаются на вкладках формы: «Справочники», «CRM», «Снабжение», «Финансы», «Производство», «Склад». В каждой строке четыре права: «Чтение», «Создание», «Изменение», «Удаление». Кнопки «Выбрать всё» и «Отменить всё» отмечают или снимают все права на открытой вкладке. Давайте приложению только те права, которые нужны для его работы.
1С:Бухгалтерия и 1С:УНФ. Отметьте права на документы, которые будете переносить в 1С. Список документов — в статьях «Интеграция с 1С:Бухгалтерия 8.3» и «Интеграция с 1С:УНФ». На скриншоте выше для приложения «1С УНФ» на вкладке «CRM» у заказов, счетов и отгрузок покупателей отмечены чтение, создание и изменение, удаление не отмечено.
БАЗИС-Мебельщик. Отметьте разрешение «Импорт спецификации (создание)». Подробнее — в статье «Интеграция с БАЗИС-Мебельщик».
Для каких интеграций нужны ключи
Ключи API нужны для 1С:УНФ, 1С:Бухгалтерии, БАЗИС-Мебельщик и ваших собственных программ, которые работают через API.
Битрикс24 и amoCRM подключаются в Настройки → Интеграции установкой приложения, Albato — по адресу вебхука. Для них приложение API создавать не нужно.
Безопасность
API использует авторизацию OAuth 2.0. У каждой интеграции свои данные доступа, а права можно ограничить только нужными разделами. Полный доступ к учетной записи передавать не нужно.
Где посмотреть список методов
Для разработчиков есть отдельная документация API. Ссылка на нее есть и на экране «API для интеграций». В документации описаны:
- доступные методы;
- параметры запросов;
- структура передаваемых данных;
- возможные ответы сервера;
- правила авторизации.
Когда стоит использовать API
API подходит, если данными с другими системами нужно обмениваться регулярно. Например:
- у компании есть интернет-магазин;
- документы нужно создавать автоматически;
- нужна синхронизация с CRM;
- компания использует собственные программы или мобильные приложения;
- данные нужно автоматически выгружать для аналитики.
Если обмен разовый или редкий, удобнее встроенные функции импорта и экспорта.
Если не уверены, подойдет ли API для вашей задачи, напишите в поддержку Цеховика.