AiHummer
Қазақша▾
Кіру
v1.0.x▾
v1.0.xstable
{ }Swagger
API/Кіріс және интеграция триггерлері

Кіріс және интеграция триггерлері

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

OpenAI-үйлесімді API-ден бөлек, AiHummer коннекторлардан, автоматтандыру платформаларынан және браузер виджетінен кіріс хабарламаларды қабылдайды әрі сіз жазыла алатын серверлік оқиға стримін шығарады. Бұл эндпоинттер сыртқы жүйелер жұмысты шлюзге қалай жеткізетінін және UI-лар қалай тірі болып қалатынын анықтайды.

Кіріс эндпоинттер

Кіріс эндпоинттер — арна коннекторлары мен арнайы интеграциялар хабарламаны қадам қозғалтқышына беретін тәсіл. Олар 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 курсоры ретінде қарастырыңыз. Қайта қосылғанда тұтынушыңызға кем дегенде бір рет жеткізуге кепілдік беру үшін сол курсордан қайта ойнатыңыз.

Келесі қайда