AiHummer
Кыргызча▾
Кирүү
v1.0.x▾
v1.0.xstable
{ }Swagger
API/Кириш жана интеграция триггерлери

Кириш жана интеграция триггерлери

v1.0.x · жаңыланды 2026-06-26

OpenAI-шайкеш APIден тышкары, AiHummer коннекторлордон, автоматташтыруу платформаларынан жана браузер виджетинен кириш билдирүүлөрдү кабыл алат, жана сиз жазыла турган сервер тарабындагы окуя агымын чыгарат. Бул эндпоинттер тышкы тутумдар шлюзга жумушту кантип жеткирээри жана интерфейстер кантип тирүү бойдон калары.

Кириш эндпоинттери

Кириш эндпоинттери — канал коннекторлору жана ыңгайлаштырылган интеграциялар билдирүүнү кезек кыймылдаткычына кантип берери. Алар X-AIHummer-Inbound-Secret баш сабында жөнөтүлгөн HMAC жалпы сыры менен корголот (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] Кириш эндпоинттери ah- API ачкычы менен корголбойт — алар X-AIHummer-Inbound-Secret HMACине таянат. Ал сырды клиент тарабындагы коддон алыс кармаңыз жана ал агып кетсе айлантыңыз.

Интеграция триггерлери (Zapier / Make)

POST /v1/integrations/trigger — Zapier жана Make сыяктуу аз-коддуу автоматташтыруу платформалары үчүн кириш чекити. Ал же X-AIHummer-Signature HMACин же 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 курсору катары кароңуз. Кайра туташууда керектөөчүңүзгө кеминде-бир-жолу жеткирүүгө кепилдик берүү үчүн ошол курсордон кайра ойнотуңуз.

Андан ары кайда