Мы продолжаем развивать украинскую онлайн-бухгалтерию Буккипер, добавлять новые операции, расчеты и документы, а также совершенствовать возможности для большего охвата бизнес-участков наших клиентов. В бухгалтерской программе BookKeeper добавлены инструменты REST API для онлайн-обмена информацией с внешними программами и сервисами.
Что такое REST API и его значение в системе Буккипер
API (сокращение от английского "Application Programming Interface"), в переводе "Прикладной программный интерфейс". В сфере взаимодействия различных бизнес-систем представляет собой набор методов обмена информацией между различными, часто не связанными между собой, системами или компонентами систем. Наличие API в онлайн-системе предоставляет пользователю возможность передавать в эту систему данные из внешнего источника или получать из этой системы информацию по запросу.
REST (сокращение от английского «Representational State Transfer»), в переводе «передача репрезентативного состояния») — название подхода к архитектуре протоколов, предоставляющих доступ к информационным ресурсам, использующим клиент-серверную модель взаимодействия с соответствующим разделением ответственности между выполняющим компонентом, который выполняет функции хранения и обновления данных (сервером), и теми компонентами, которые занимаются отображением пользовательских данных и реагированием на его действия (клиентом), а также обуславливает передачу информации в виде стандартных форматов с поддержкой кэширования.
Как результат, публикация REST API Буккипера означает, что с этого момента бухгалтерию Bookkeeper можно увязать с любой бизнес-системой пользователя для автоматизированного обмена значимой для бухгалтерии информацией.
Примеры использования REST API для интеграции с сервисами
В Буккипере инструменты API давно используются для обмена информацией с «умными» банками Украины. В частности, клиенты Приват24 для бизнеса и Моно загружают платежные документы и банковские выписки в Буккипер в режиме реального времени онлайн. А клиенты Bookkeeper, ведущие ВЭД, онлайн загружают курсы иностранных валют в гривне, установленные НБУ. Так работает API: определяет, какую информацию передавать и какую сущность создавать на стороне клиента. В данном случае, Приват, Моно и НБУ выполняют роль сервера, где хранится определенная информация, а Буккипер — клиента, инициирующего обмен информацией и/или выполнения сервером нужных клиенту действий. Также с помощью REST API в Буккипере сейчас можно импортировать из 1С существующую базу справочников номенклатуры и контрагентов с помощью существующей обработки для 1С.
По этому же принципу внешнюю оперативную управленческую систему клиента (это может быть интернет-магазин, фронт-система, система класса ERP или CRM) с помощью REST API можно научить внешнюю систему подавать команду на создание в бухгалтерской программе Буккипер необходимых документов и выполнять определенные действия. К примеру, если в собственной системе вы перемещаете между складами или продаете товары, то такую работу не нужно будет повторно выполнять в Буккипер вручную. Информация об этих операциях будет передаваться в Буккипер через программный интерфейс, и в бухгалтерской программе будут создаваться соответствующие документы: накладные на перемещение между складами, расходные накладные, счета и т.д.
Таким образом, использование API:
- экономит время и ресурсы — не нужно выполнять одну и ту же работу дважды;
- усиливает контроль за имеющимися остатками и заказами;
- ускоряет обработку информации и совершенствует оперативный учет;
- налаживает и улучшает связь между отделом бухгалтерии и другими отделами компании.
Возможности передачи информации по внешним программам и сервисам в Буккипер
Авторизация для взаимодействия с сервисом Буккипер по API всегда выполняется через ключ API, который формируется пользователем самостоятельно во вкладке «Ключ API» в Свойствах моей фирмы в Личном кабинете пользователя Буккипер.
Разработчикам будет полезно знать, что взаимодействие с сервисом происходит в формате JSON в кодировке UTF-8.
Все элементы системы имеют уникальный идентификатор в виде GUID (англ. Globally Unique Identifier – статистически уникальный 128-битный идентификатор). Если внешняя система создает сущность, то она должна самостоятельно определить этот идентификатор.
Описание основных элементов REST API, доступных в Буккипере
Описание API сервиса Буккипер для разработчиков доступно по по ссылке и будет дополняться по мере добавления новых методов обмена информацией.
На сегодняшний день уже доступны следующие конечные точки и методы:
- Конечная точка /document отвечает за работу с документами.
Методы:
/document/load - позволяет скачать документ
/document/update – позволяет создать или обновить документ
- Конечная точка /agent отвечает за работу с контрагентами.
Методы:
/agent/index/ загружает список контрагентов.
/agent/load/ загружает контрагента по его идентификатору.
/agent/find/ выполняет поиск контрагента по значению.
/agent/update создает или обновляет свойства контрагента.
/agent/batch создает или обновляет свойства контрагентов пакетом.
- Конечная точка /entity отвечает за работу с объектами учета.
Методы:
/entity/load скачивает объект учета по его идентификатору.
/entity/index загружает список объектов учета.
/entity/find производит поиск объектов учета по значению.
/entity/update создает или обновляет свойства объекта учета.
/entity/batch создает или обновляет свойства объектов учета пакета.
- Конечная точка /store отвечает за работу со складами.
Методы:
/store/load скачивает состав по его идентификатору.
/store/index загружает список складов.
/store/update создает или обновляет свойства склада.
/store/batch создает или обновляет свойства складов пакетом.
- Конечная точка /contract отвечает за работу с договорами.
Методы будут описаны позже.
Мы открыты для развития и совершенствования инструмента REST API. Если у вас есть идеи, каким образом еще можно наладить варианты взаимодействия между системами, а также по вопросам организации обмена вашего программного продукта с бухгалтерией Буккипер — обращайтесь в техническую поддержку.
support@bookkeepertech.com
https://t.me/BookKeeper_Support_bot
viber://pa?chatURI=bookkeepersupport
https://m.me/bookkeepersaas
+38 067 250 8485
+38 050 446 0110
+38 044 333 9579
