Довідник методів API Bimp
Довідник API Bimp містить усі методи публічного API, згруповані за ресурсами: одна сторінка на ресурс (наприклад, «Замовлення покупця» або «Номенклатура») з параметрами запиту, полями відповіді і прикладом curl. Сторінки згенеровані зі специфікації OpenAPI, тож відповідають поточній версії API.
Як влаштовані методи API Bimp
Методи API Bimp згруповані за ресурсами: шлях має вигляд /org2/<ресурс>/<дія>, наприклад /org2/invoiceForCustomerPayment/api-readList. Базова адреса — https://app.bimpsoft.com, формат — JSON.
Типові дії ресурсу:
| Дія | Що робить |
|---|---|
api-readList | список об’єктів з пагінацією і фільтрами |
api-read | один об’єкт за uuid |
api-create | створення об’єкта |
api-update | зміна об’єкта за uuid |
api-saveExternalId | прив’язка ідентифікатора з вашої системи — див. Зовнішні ID |
Кожен запит, крім входу, передає токен компанії в заголовку access-token. Як отримати токен — у статті Початок роботи з API; обмеження на кількість запитів і розмір сторінки — у статті Ліміти, пагінація і помилки.
Як читати сторінку ресурсу
Сторінка ресурсу починається з таблиці методів, далі кожен метод описано окремо: шлях, призначення, поля тіла запиту (з позначкою обов’язкових), поля відповіді в об’єкті data і приклад запиту curl. Вкладені поля записано через крапку: counterparty.uuid означає поле uuid всередині об’єкта counterparty, а products[].count — поле кожного елемента масиву products.
Усі ресурси API
| Ресурс | Шлях | Методів |
|---|---|---|
| Авторизація | /org2/auth/ | 4 |
| Банківські рахунки | /org2/bankAccounts/ | 3 |
| Валюти | /org2/currency/ | 2 |
| Введення початкових залишків | /org2/enteringOpeningBalances/ | 4 |
| Вебхуки | /org2/webhook/ | 4 |
| Вебхуки (підписки) | /org2/webhooks/ | 3 |
| Виробничі завдання | /org2/production-task/ | 4 |
| Групи номенклатури | /org2/nomenclature-group/ | 4 |
| Договори | /org2/contract/ | 6 |
| Додаткові витрати | /org2/additionalSpendings/ | 4 |
| Залишки за фінансуванням | /org2/financing-balance/ | 1 |
| Залишки і комплекти | /org2/inventory/ | 6 |
| Замовлення на виробництво | /org2/production-order/ | 6 |
| Замовлення покупця | /org2/invoiceForCustomerPayment/ | 14 |
| Замовлення постачальнику | /org2/invoiceForSupplierPayment/ | 6 |
| Заявки на витрату коштів | /org2/expenseRequest/ | 5 |
| Збірка (виробництво) | /org2/production-assembly/ | 4 |
| Зображення | /org2/images/ | 1 |
| Інтеграція Zoho People | /org2/integration/ | 1 |
| Інші витрати | /org2/otherExpenses/ | 4 |
| Інші доходи | /org2/otherIncome/ | 4 |
| Каси | /org2/cashRegistry/ | 2 |
| Компанії | /org2/company/ | 1 |
| Контрагенти | /org2/counterparty/ | 14 |
| Користувачі | /org2/user/ | 1 |
| Надходження товарів, послуг | /org2/purchaseInvoice/ | 5 |
| Налаштування інтеграцій | /org2/integrationSettings/ | 7 |
| Напрями діяльності | /org2/lineOfBusiness/ | 1 |
| Номенклатура (товари та послуги) | /org2/nomenclature/ | 15 |
| Номенклатура контрагента | /org2/counterpartyNomenclature/ | 4 |
| Обладнання | /org2/machinery/ | 1 |
| Одиниці виміру | /org2/unitsOfMeasurment/ | 1 |
| Оплата від покупця | /org2/customerPayment/ | 6 |
| Оплата постачальнику | /org2/paymentToSupplier/ | 5 |
| Оприбуткування запасів | /org2/inventoryPosting/ | 1 |
| Організації | /org2/organization/ | 1 |
| Отримання інвестицій | /org2/investmentObtainment/ | 4 |
| Отримання кредитів | /org2/loanObtainment/ | 4 |
| Партії | /org2/party/ | 3 |
| Перекази між рахунками | /org2/interaccountTransfer/ | 4 |
| Переміщення запасів | /org2/movementOfInventories/ | 5 |
| План рахунків | /org2/chartOfAccount/ | 1 |
| Повернення інвестицій | /org2/investmentRepayment/ | 4 |
| Повернення коштів від постачальника | /org2/refundFromSupplier/ | 4 |
| Повернення коштів покупцю | /org2/refundToCustomer/ | 4 |
| Повернення кредитів | /org2/loanRepayment/ | 4 |
| Повернення товару від покупця | /org2/customer-inventories-return/ | 5 |
| Повернення товару постачальнику | /org2/refundSupplier/ | 5 |
| Прайс-листи | /org2/priceList/ | 7 |
| Продаж товарів, послуг | /org2/salesInvoice/ | 11 |
| Проєкти | /org2/project/ | 1 |
| Склади | /org2/warehouse/ | 1 |
| Специфікації | /org2/specification/ | 4 |
| Списання запасів | /org2/writeOffOfInventories/ | 5 |
| Співробітники | /org2/employee/ | 5 |
| Ставки ПДВ | /org2/vat/ | 2 |
| Статті витрат | /org2/expenseItems/ | 1 |
| Статті доходів | /org2/incomeItems/ | 1 |
| Типи адрес | /org2/addressType/ | 1 |
Часті питання
Де взяти специфікацію OpenAPI для API Bimp?
Інтерактивна документація зі специфікацією доступна за адресою https://app.bimpsoft.com/docs. Там можна переглянути схеми і надіслати тестовий запит.
Чому більшість методів API Bimp використовують POST?
У Bimp навіть читання (api-read, api-readList) виконується POST-запитом з параметрами в JSON-тілі. GET використовують лише окремі методи, наприклад залишки комплектів.