English

Налаштування інтеграції¶

Ця сторінка проведе через отримання API-ключа та налаштування вебхуків.

1. Отримайте API-ключ¶

В інтерфейсі HugeProfit відкрийте Налаштування → Інтеграції → Інше → API v2 і натисніть Підключити. Ключами керує адміністратор акаунта; ключів може бути кілька — по одному на кожну підключену систему.

Ключі API v2 у списку інтеграцій

Дайте ключу назву (напр. «Синк складу»).
Оберіть його права — надайте лише те, що потрібно інтеграції (див. крок 2).

Створення ключа

Скопіюйте ключ одразу — він показується лише раз (hp_live_…). У списку видно тільки його початок.

Ключ показується один раз

Загубили? Перевипустіть ключ у його налаштуваннях: отримаєте новий, старий перестане працювати протягом 30 секунд, а вебхуки й замовлення, прийняті через ключ, залишаться.
Деактивуйте ключ, щоб призупинити його: запити відхилятимуться протягом 30 секунд, вебхуки ключа не надсилатимуться. Видалення ключа видаляє і його вебхуки разом із журналом доставок.

Перевірте, що працює:

curl https://crm.h-profit.com/bapi-v2/me \
  -H "Authorization: hp_live_ваш_ключ"

200 з вашим user_id та scopes означає, що все готово.

2. Оберіть права¶

У формі ключа три варіанти:

Варіант	Які scopes надає
Повний доступ	`*` — усі ресурси, читання і запис
Тільки читання	`<ресурс>:read` для кожного ресурсу
Вибірково	для кожного ресурсу: немає доступу, читання (`<ресурс>:read`) або читання і запис (`<ресурс>:*`)

Через API scopes мають формат resource:action (read/write); сам :write читання не дає. Надавайте мінімум: інтеграції для звітів вистачить sales:read, products:read, clients:read, …; двостороння синхронізація потребує resource:*. Зміна прав починає діяти протягом 30 секунд. Повний перелік — в Автентифікації.

3. Створіть підписку на вебхук¶

Вебхуки можна створити в налаштуваннях ключа (Налаштування → Інтеграції → API v2 → Налаштування → Вебхуки → Додати вебхук) або через API:

curl -X POST https://crm.h-profit.com/bapi-v2/webhooks \
  -H "Authorization: hp_live_ваш_ключ" \
  -H "Content-Type: application/json" \
  -d '{ "event": "order_create", "url": "https://yoursite.com/hooks/sales" }'

Додавання вебхука

Оберіть подію з каталогу.
Вкажіть URL приймача (має бути доступний по HTTPS).
Збережіть повернений secret — він потрібен для перевірки підпису. Як і ключ, він показується лише раз; новий можна випустити в налаштуваннях підписки.

4. Протестуйте ендпоінт¶

Перш ніж покладатися на живі події, надішліть зразкову доставку: кнопка Перевірити біля підписки в налаштуваннях ключа або запит до API:

curl -X POST https://crm.h-profit.com/bapi-v2/webhooks/test \
  -H "Authorization: hp_live_ваш_ключ" \
  -H "Content-Type: application/json" \
  -d '{ "webhook_id": 5, "data": { "ping": 1 } }'

Результат тестової доставки

Результат показує точний статус, який повернув ваш ендпоінт, час відповіді й тіло, яке ми надіслали. Виправляйте приймач, доки не побачите "ok": true (в інтерфейсі — Перевірка пройшла успішно).

5. Запуск¶

Переконайтесь, що приймач перевіряє підпис і швидко повертає 2xx.
Слідкуйте за журналом доставок: Журнал біля підписки або GET /webhooks/deliveries. Невдалі доставки повторюються автоматично.
Дедуплікуйте за X-GP-Delivery — доставки at-least-once.

Журнал доставок

Готово — ваша інтеграція тепер отримує події в реальному часі та може читати/писати через API.