AiHummer
Кыргызча▾
КирүүЖеке кабинет
v1.0.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/Ички жана Интеграциялоочу Триггерлер

Ички жана Интеграциялоочу Триггерлер

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

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

Кирүү учу

Кирүүчү чекиттер канал туташтыргычтары жана ыңгайлаштырылган интеграциялар билдирүүнү буйрук кыймылдаткычына өткөрүүчү жол болуп саналат. Алар тарабынан корголот HMAC бөлүшүлгөн сыр жиберилгенде X-AIHummer-Inbound-Secret жаглавие (бул AIHUMMER_INBOUND_SECRET settings-catalog ачкычы — Админ UIда Management → Settings аркылуу же менен жөндөлгөн aihummer settings set, эмес gateway.env).

Метод жана жол Максат
POST /v1/inbound/telegram Телеграммга келген түпнуска жүктөмдөр
POST /v1/inbound/generic Электрондук почта → вебхук, cron жана ыңгайлаштырылган колдонмолор үчүн жалпы кирүү
POST /v1/inbound/binding/status Каналга байланыш статусун отчеттук кылуу

Бул жалпылык endpoint – бул каалаган булагын 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 бул төмөн коддолуучу автоматташтырууу платформалары үчүн кириш чекити катары Запьер жана Жасау. Бул чекит адатта өчүрүлгөн: чейин AIHUMMER_INBOUND_TRIGGER_SECRET орнотуулар жөндөлгөндө ал жооп берет 501 Not Implemented. Бул ажыратуу сыр, айырмаланып турган AIHUMMER_INBOUND_SECRET; ар бир settings-catalog ачкычындай, ал админ интерфейсинде (Management → Settings) же менен тандап коюлат 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 көрсөткүч. Иштетилүүдө кайра туташуу, ошол курсордон кайра ойнотуу, кеминде-бир жолу жеткирүүнү камсыздоо үчүн түзүм

Келерки кайда