AiHummer
Беларуская▾
УвайсціАсабісты кабінет
v1.2.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/Унутраныя і інтэграцыйныя трыгеры

Унутраныя і інтэграцыйныя трыгеры

v1.2.x · абноўлена 2026-07-27

Акрамя сумяшчальнага з OpenAI API, AiHummer прымае уваходныя паведамленні з злучальнікаў і аўтаматызаваных платформаў, і выпрацоўвае паток падзей на баку сервера вы можаце падпісацца. Гэтыя канцыпункты — гэта спосаб, якім знешнія сістэмы дастаўляюць працу на шлюз і як карыстальніцкія інтэрфейсы застаюцца актыўнымі.

Уваходныя канечныя кропкі

Уваходныя канцы — гэта спосаб, якім канальныя разьяднальнікі і карыстальніцкія інтэграцыі перадаюць паведамленні рухавіку пераключэння. Яны абаронены HMAC агульны сакрэт адпраўлена ў X-AIHummer-Inbound-Secret загаловак (AIHUMMER_INBOUND_SECRET ключ каталога налад — настроены ў адміністрацыйным інтэрфейсе ў раздзеле Кіраванне → Налады або з дапамогай aihummer settings set, не ў gateway.env).

Метад і шлях Мэта
POST /v1/inbound/telegram Родныя ўнутраныя нагрузкі Telegram
POST /v1/inbound/generic Агульны ўваход для электроннай пошты→вэб-хук, cron і карыстальніцкія прыкладанні
POST /v1/inbound/binding/status Даслаць статус прывязкі канала

Гэта агульны endpoint — гэта самы просты спосаб падаць любы крыніцу ў AiHummer. Адпраўце невялікае цела JSON з назвай канала, стабільным знешнім ідэнтыфікатарам і тэкстам паведамлення:

curl https://your-aihummer.example/v1/inbound/generic \
  -H "X-AIHummer-Inbound-Secret: $AIHUMMER_INBOUND_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "external_id": "ticket-4821",
    "text": "A customer asks whether order #4821 has shipped."
  }'

[!NOTE] Агульны прыёмшчык патрабуе стандартнага працоўнага прастору. Устанавіць AIHUMMER_DEFAULT_WORKSPACE_ID такім чынам, уваходныя паведамленні могуць быць маршрутызаваны.

[!WARNING] Уваходныя пункты не ахоўваюцца ah- Ключ API — яны абапіраюцца на X-AIHummer-Inbound-Secret HMAC. Трымайце гэты сакрэт па-за кодам на баку кліента і круціце гэта, калі яно працякае

Трыгеры інтэграцыі (Zapier / Make)

POST /v1/integrations/trigger з’яўляецца кропкай уваходу для платформаў аўтаматызацыі з нізкім кодам, такіх як Зап’ер і ЗрабіцьКанчатковая кропка адключана па змаўчанні: да AIHUMMER_INBOUND_TRIGGER_SECRET калі ўстаноўка сканфігураваная, яна адказвае **501 Not Implemented**Гэта аддзяляць сакрэтны, адрозны ад AIHUMMER_INBOUND_SECRET; як і кожны ключ каталога налад, ён усталёўваецца ў адміністрацыйным інтэрфейсе (Кіраванне → Налады) або з дапамогай aihummer settings set.

Як толькі наладжаны, канчатковы пункт прымае альбо адзін X-AIHummer-Signature HMAC або маркер Bearer у форме Authorization: Bearer <the AIHUMMER_INBOUND_TRIGGER_SECRET value>.

curl https://your-aihummer.example/v1/integrations/trigger \
  -H "Authorization: Bearer $AIHUMMER_INBOUND_TRIGGER_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "zapier",
    "external_id": "lead-99",
    "text": "New lead captured from the contact form."
  }'

Backend Admin Sessions

Гэтыя дзве канчатковыя кропкі захаваны як унутраны транспарт старонкі Admin Sessions. Гэта не падтрыманы ўбудаваны кліенцкі канал.

Метад і шлях Прызначэнне
POST /v1/web/session Адкрыць або працягнуць дыялог Admin Sessions
GET /v1/web/stream Атрымліваць адказ дыялогу як SSE

Паток падзей

GET /v1/events/stream ёсць працягальны Струмень падзей Server-Sent Events для падзей шлюза. Канчатковая кропка мае дзве абавязковыя патрабаванні:

  1. Гэта ?workspace_id=<id> параметр абавязковы — без яго запыт адкідваецца з 400Ахоўнік арандатар правярае, што працоўнае месца належыць арэндытальнік тых, хто тэлефануе; чужы workspace_id вынікі 403.
  2. Трэба аўтарызацыя — сесія адміністратара (cookie) або ah- АПІ увесці ў Authorization: Bearer загаловак. Без яго адказ будзе 401.

Перамяніць ?since= курсоў указчык працягвае з таго месца, дзе была перапыненая папярэдняя сувязь, таму пасля паўторнага падключэння падзеі не губляюцца.

# Subscribe from the beginning
curl -N -H "Authorization: Bearer ah-..." \
  "https://your-aihummer.example/v1/events/stream?workspace_id=<id>"

# Resume after a known cursor
curl -N -H "Authorization: Bearer ah-..." \
  "https://your-aihummer.example/v1/events/stream?workspace_id=<id>&since=<cursor>"

[!TIP] Лячыце значэнне, якое нясе кожная падзея, як наступнае since курсёр. Уключана перазлучыцца, паўтарыць ад гэтага курсора, каб гарантаваць дастаўку прынамсі адзін раз спажывец

Куды далей