Ми продовжуємо розвивати українську онлайн-бухгалтерію Буккіпер, додавати нові операції, розрахунки та документи, а також удосконалювати можливості для більшого охоплення бізнес-ділянок наших клієнтів. Наразі в бухгалтерській програмі BookKeeper додано інструменти REST API для онлайн-обміну інформацією із зовнішніми програмами та сервісами.
Що таке REST API та його значення в системі Буккіпер
API (скорочення від англійського «Application Programming Interface»), в перекладі «Прикладний програмний інтерфейс». В сфері взаємодії різноманітних бізнес-систем являє собою набір методів для обміну інформацією між різними, часто не пов'язаними між собою, системами чи компонентами систем. Наявність API в онлайн-системі надає користувачеві можливість передавати в цю систему дані із зовнішнього джерела, або отримувати з цієї системи інформацію по запиту.
REST (скорочення від англійського «Representational State Transfer»), в перекладі «передача репрезентативного стану») — назва підходу до архітектури протоколів, які надають доступ до інформаційних ресурсів, що використовує клієнт-серверну модель взаємодії з відповідним розділенням відповідальності між компонентом, який виконує функції зберігання та оновлення даних (сервером), і тими компонентами, які займаються відображенням даних для користувача та реагуванням на його дії (клієнтом), а також обумовлює передавання інформації у вигляді стандартних форматів з підтримкою кешування.
Отже, публікація REST API Bookkeeper означає, що з цього моменту бухгалтерію Буккіпер можна пов'язати з будь-якою бізнес-системою користувача для автоматизованого обміну значущою для бухгалтерії інформацією.
Приклади використання REST API для інтеграції із сервісами
В Буккіпер інструменти АРІ вже досить давно використовуються для обміну інформацією з «розумними» банками України. Зокрема, клієнти Приват24 для бізнесу і Моно завантажують платіжні документи та банківські виписки в Буккіпер в режимі реального часу онлайн. А клієнти Bookkeeper, які ведуть ЗЕД, онлайн завантажують курси іноземних валют до гривні, встановлені НБУ. Так працює АРІ: визначає яку інформацію передавати і яку сутність створювати на боці клієнта. В даному випадку Приват, Моно та НБУ виконують роль сервера, де зберігається певна інформація, а Буккіпер — клієнта, який ініціює обмін інформацією та/або виконання сервером потрібних клієнту дій. Також за допомогою 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
