AiHummer
Тоҷикӣ▾
Даромадан
v1.0.x▾
v1.0.xstable
{ }Swagger
API/Триггерҳои воридшаванда ва интеграция

Триггерҳои воридшаванда ва интеграция

v1.0.x · навсозӣ шуд 2026-06-26

Берун аз API-и OpenAI-мутобиқ, 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 Гузориши ҳолати алоқабандии канал

Нуқтаи ниҳоии generic соддатарин усули ворид кардани ҳар манбаъ ба 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 нуқтаи вуруд барои платформаҳои автоматизатсияи low-code, ба монанди Zapier ва Make аст. Он ё як HMAC-и X-AIHummer-Signature ё токени Bearer-ро қабул мекунад.

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 баррасӣ кунед. Ҳангоми пайвасти дубора, аз он курсор такрор кунед, то расонидани камаш-як-бор ба истеъмолкунандаи худро кафолат диҳед.

Минбаъд ба куҷо