HugeProfit API v2¶
API v2 — це чистий, зручний для інтеграторів REST-інтерфейс до HugeProfit: замовлення, продажі, товари, залишки, клієнти, поставки, витрати, виробництво та нативні вебхуки. Він працює паралельно зі старим API v1 — v1 продовжує працювати, а v2 — це нова поверхня з послідовним іменуванням і передбачуваною поведінкою.
- Базовий URL:
https://crm.h-profit.com/bapi-v2 - Формат: JSON на вхід і вихід — завжди в стандартному конверті.
- Авторизація: один API-ключ у заголовку
Authorization— див. Автентифікація.
Уперше тут? Три кроки
- Створіть API-ключ в інтерфейсі — Налаштування інтеграції.
- Викличте
GET /bapi-v2/me, щоб перевірити ключ. - Прочитайте Домовленості і переходьте до Ресурсів.
Чому v2 (проти v1)¶
v1 (/bapi) |
v2 (/bapi-v2) |
|
|---|---|---|
| Назви полів | змішані, внутрішні (mid, prapaid, fnsku) |
чисті та стабільні (warehouse_id, prepaid, sku) |
| Форма відповіді | різна на кожному ендпоінті | один конверт усюди |
| Вкладені дані | заголовок/позиції окремо | один об'єкт із вкладеним масивом items |
| Кілька ресурсів | багато запитів | один composite /query |
| Вебхуки | налаштовувались, але не доставлялись | надійна черга, підпис, ретраї |
v2 — це міст: він ховає особливості внутрішньої системи за стабільною схемою. Вам не потрібно знати, як дані зберігаються всередині.
Швидкий старт¶
# 1. Хто я? (перевірка ключа + його scopes)
curl https://crm.h-profit.com/bapi-v2/me \
-H "Authorization: hp_live_ваш_ключ"
# 2. Останні продажі (кожна продажа — один об'єкт із вкладеним масивом `items`)
curl "https://crm.h-profit.com/bapi-v2/sales?limit=5" \
-H "Authorization: hp_live_ваш_ключ"
Кожна успішна відповідь має вигляд:
Карта API¶
- Автентифікація — ключі, scopes, заголовок
Authorization. - Домовленості — конверт, пагінація, формати грошей/часу, CORS.
- Ресурси — усі ендпоінти: товари, продажі, замовлення, клієнти, …
- Composite-запит — кілька ресурсів (і вкладені зв'язки) за один виклик.
- Вебхуки — підписка на події, перевірка підпису, ретраї.
- Помилки — конверт помилки та стабільні коди.
- Налаштування інтеграції — створення ключа та вебхуків в інтерфейсі.