#305

В адмінці: API → Тестування API облікової системи.

Що це

Пісочниця для інтеграції з вашою обліковою системою. Тут зібрані всі точки, через які наша система сама стукає до облікової системи: запитує ціни, перевіряє наявність на складі, тягне зв'язки матеріал↔кромка тощо. На сторінці видно, які endpoint'и у вас налаштовані, а які — ні; кожен можна вживу протестувати з реальним запитом і подивитись, що повернула облікова система.

Що ви бачите

Список точок звернення до облікової системи — картки з однаковою структурою:

  • Назва та короткий опис точки.
  • Що це дає — простими словами: яку функціональність вмикає налаштування цього endpoint'а.
  • Кроки налаштування — коротка інструкція: що попросити у вашого програміста облікової системи, який ключ параметра знайти в адмінці, куди вставити URL.
  • Поточний URL — якщо вже налаштований. Порожньо — значить endpoint не працює.
  • Кнопка «Тест» — переходить на вкладку з формою реального запиту, показує request/response.

Доступні точки інтеграції

Базовий набір (можуть додаватись у міру розвитку системи):

  • Отримання цін матеріалів — наша система запитує у облікової системи актуальні ціни на листові матеріали. Без цього налаштування ціни беруться з локальної бази й можуть відрізнятись від облікової системи.
  • Отримання цін послуг — те саме для послуг (обробка, фурнітура).
  • Перевірка наявності на складі — перед запуском замовлення у виробництво система питає у облікової системи, чи є всі потрібні матеріали. Без цього замовлення можуть піти у виробництво і впасти на «немає матеріалу».
  • Отримання кромки для матеріалу — яка кромка йде в комплекті з конкретним листовим матеріалом. Використовується при синхронізації номенклатури; інакше відповідність матеріал→кромка доводиться налаштовувати вручну.

Під час запиту цін на матеріали й послуги платформа передає в облікову систему реального контрагента замовлення — клієнт бачить свої договірні ціни, а не роздрібні. Якщо контрагента в базі не заведено або не прив'язано до облікової системи, розрахунок не падає: повертаються роздрібні ціни з зрозумілим поясненням, що саме потрібно дозаповнити в даних. Також виправлено випадок роботи користувача однієї фірми з каталогом іншої: запит цін тепер іде строго в облікову систему тієї фірми, чий каталог використовується.

Як налаштувати

Загальний рецепт для кожної точки однаковий:

  1. Попросити вашого програміста облікової системи створити HTTP-сервіс (endpoint) з потрібним форматом запиту/відповіді. Опис формату — всередині картки на сторінці тестування.
  2. Отримати від програміста URL цього сервісу (має починатись з https://; локальна облікова система може бути на http://).
  3. Зайти в Параметри → Параметри фірми, знайти параметр із вказаним у картці ключем і вставити URL.
  4. Повернутися на сторінку тестування і натиснути «Тест» — одразу видно, відповідає облікова система чи ні, і які дані повертає.

Тест запиту

На вкладці тесту для обраної точки ви бачите:

  • Endpoint URL — куди полетить запит.
  • HTTP-метод (зазвичай POST).
  • Заголовки (включно з API-Key облікової системи якщо заданий).
  • Тіло запиту — типовий приклад, який можна одразу відправити або відкоригувати (наприклад, підставити реальний code1c існуючого товару/замовлення).
  • Кнопку «Відправити» — дає сирий відповідь від облікової системи: код відповіді, тіло, тривалість.

Що важливо

  • Тестові запити — реальні: вони справді йдуть у вашу облікову систему і можуть змінювати її дані (наприклад, тест «Прийняти замовлення» створить в обліковій системі запис). Будьте обережні на проді — спочатку тестуйте на staging-версії облікової системи.
  • Усі налаштування точок зберігаються у виробничих параметрах вашої фірми — змінювати можна без редеплою.
  • В одному з ключів у системі історично є одрук («avilable» замість «available») — це не баг, залишено для сумісності зі старими інсталяціями. Підказка в картці попередить.
  • Доступ — усі адміни вашої фірми.