AiHummer
Беларуская▾
Увайсці
v1.0.x▾
v1.0.xstable
{ }Swagger
API/Уваходныя і інтэграцыйныя трыгеры

Уваходныя і інтэграцыйныя трыгеры

v1.0.x · абноўлена 2026-06-26

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

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

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

Метад і шлях Прызначэнне
POST /v1/inbound/telegram Натыўныя ўваходныя нагрузкі Telegram
POST /v1/inbound/generic Універсальны ўваход для email→webhook, cron і карыстальніцкіх дадаткаў
POST /v1/inbound/binding/status Паведаміць статус прывязкі канала

Універсальная канчатковая кропка — гэта самы просты спосаб падаваць любую крыніцу ў 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] Уваходныя канчатковыя кропкі не абаронены API-ключом ah- — яны абапіраюцца на HMAC X-AIHummer-Inbound-Secret. Трымайце гэты сакрэт па-за кліенцкім кодам і рацыруйце яго, калі ён уцячэ.

Інтэграцыйныя трыгеры (Zapier / Make)

POST /v1/integrations/trigger — гэта ўваходны пункт для нізкакодавых платформаў аўтаматызацыі, такіх як Zapier і Make. Ён прымае альбо HMAC X-AIHummer-Signature, альбо Bearer token.

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

Вэб-віджэт

Убудоўвальны вэб-віджэт выкарыстоўвае дзве канчатковыя кропкі: адну для адкрыцця сесіі і адну для стрымінгу адказу асістэнта.

Метад і шлях Прызначэнне
POST /v1/web/session Адкрыць сесію віджэта
GET /v1/web/stream Атрымліваць адказы віджэта як SSE 
# 1) Open a session
curl https://your-aihummer.example/v1/web/session \
  -H "Content-Type: application/json" \
  -d '{}'

# 2) Stream responses (Server-Sent Events)
curl -N https://your-aihummer.example/v1/web/stream

Стрым падзей

GET /v1/events/stream — гэта ўзнаўляльная стужка Server-Sent Events падзей шлюза. Перадайце курсор ?since=, каб узнавіць з таго месца, дзе спынілася папярэдняе злучэнне, так што перападключэнне ніколі не губляе падзеі.

# Subscribe from the beginning
curl -N https://your-aihummer.example/v1/events/stream

# Resume after a known cursor
curl -N "https://your-aihummer.example/v1/events/stream?since=<cursor>"

[!TIP] Разглядайце значэнне, якое нясе кожная падзея, як наступны курсор since. Пры перападключэнні прайграйце з гэтага курсора, каб гарантаваць дастаўку “хаця б адзін раз” вашаму спажыўцу.

Куды далей