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

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

v1.0.x · жаңартылды 2026-07-27

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

Кіріс нүктелері

Кіріс соңғы нүктелері арқылы арна коннекторлары мен арнайы интеграциялар хабарламаларды айналым қозғалтқышына береді. Оларды X-AIHummer-Inbound-Secret тақырыбымен жіберілетін ортақ HMAC құпиясы қорғайды (AIHUMMER_INBOUND_SECRET — параметрлер каталогының кілті; ол әкімші интерфейсіндегі Басқару → Параметрлер бөлімінде немесе aihummer settings set пәрменімен бапталады, gateway.env ішінде емес).

Әдіс және жол Мақсат
POST /v1/inbound/telegram Туған Telegram кіріс жүктеме деректері
POST /v1/inbound/generic Электрондық поштаға арналған жалпы кіріс→вебхук, 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] Кіріс соңғы нүктелер қорғаусыз ah- API кілті — олар оған сүйенеді X-AIHummer-Inbound-Secret HMAC. Бұл құпияны клиент жағындағы кодтан тыс сақтаңыз және ағып тұрса, оны бұраңыз.

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

POST /v1/integrations/trigger төмен кодты автоматтандыру платформалары үшін кіріс нүктесі болып табылады, мысалы Zapier және Жасау. Соңы нүкте әдепкі бойынша өшірілген: дейін 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."
  }'

Admin Sessions backend

Бұл екі эндпоинт Admin Sessions бетінің ішкі тасымалы ретінде сақталған. Олар клиент сайтына ендірілетін қолдаулы арна емес.

Әдіс және жол Мақсаты
POST /v1/web/session Admin Sessions диалогын ашу немесе жалғастыру
GET /v1/web/stream Диалог жауабын SSE ретінде алу

Оқиғалар ағыны

GET /v1/events/stream болып табылады қайта жалғастырылатын Шлюз оқиғаларының сервер жіберетін оқиғаларының ағыны. Энедпоинттың екі қатал талабы бар:

  1. Бұл ?workspace_id=<id> параметр міндетті — онысыз өтініш пен қабылданбайды 400. Жалға алушының күзетшісі жұмыс кеңсесінің осыған тиесілі екенін тексереді қоңырау шалған адамның жалдаушысы; басқа біреудің workspace_id өндірістер 403.
  2. Аутентификация қажет — әкімші сессиясы (cookie) немесе бір ah- API кілт енгізу 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 көрсеткіш. Болжалды қайта қосылыңыз, сол курсордан қайта ойнатыңыз, кем дегенде бір рет жеткізуді қамтамасыз ету үшін тұтынушы.

Келесі қайда