AiHummer
Тоҷикӣ▾
ВоридшавӣКабинети шахсӣ
v1.0.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/Триггерҳои воридшавӣ ва муттаҳидсозӣ

Триггерҳои воридшавӣ ва муттаҳидсозӣ

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

Ҷуз API-и мувофиқ бо OpenAI, AiHummer қабул мекунад паёмҳои воридшаванда аз пайвасткунакҳо ва платформаҳои автоматӣ, ва мебардорад як ҷараёни рӯйдодҳои тарафи сервер Шумо метавонед ба онҳо обуна шавед. Ин нуқтаҳои ниҳоӣ равандҳое мебошанд, ки системаҳои беруна корро ба шлюз мерасонанд ва UIҳоро зинда нигоҳ медоранд.

Нуқтаҳои воридшавӣ

Нуқтаҳои воридшавӣ роҳест, ки пайвасткунакҳои канал ва ҳамгироии фармоишӣ паёмро ба муҳаррики гардиш медиҳад. Онҳо бо Сирри муштараки HMAC фиристода шуд дар X-AIHummer-Inbound-Secret сарлавҳа (ин AIHUMMER_INBOUND_SECRET калиди каталог-настроӣ — дар ИҶОТИ идоракунӣ зери Идоракунӣ → Танзимот ё бо aihummer settings set, на дар gateway.env).

Роҳ ва усул Мақсад
POST /v1/inbound/telegram Маҷмӯи воридшавандаи аслии Telegram
POST /v1/inbound/generic Воридшавии умумӣ барои почтаи электронӣ→вебҳук, крона ва барномаҳои фармоишӣ
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монанди ҳар калиди феҳристи танзимот, он дар интерфейси идоракунӣ (Идоракунӣ → Танзимот) ё бо 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."
  }'

Backend-и Admin Sessions

Ин ду нуқтаи ниҳоӣ ҳамчун нақлиёти дохилии саҳифаи Admin Sessions нигоҳ дошта шудаанд. Онҳо канали ҷойгиршавандаи дастгиришаванда барои муштарӣ нестанд.

Усул ва масир Мақсад
POST /v1/web/session Кушодан ё идома додани муколамаи Admin Sessions
GET /v1/web/stream Қабули ҷавоби муколама ҳамчун SSE

Ҷараёни рӯйдодҳо

GET /v1/events/stream аст давомёбанда Пайгирии рӯйдодҳои шлюз тавассути Server-Sent Events. Нуқтаи ниҳоӣ ду талаботи қатъиро дорад:

  1. Он ?workspace_id=<id> параметр ҳатмӣ аст — бидуни он дархост рад карда мешавад бо 400Нозири иҷоранишинӣ тасдиқ мекунад, ки макони корӣ ба иҷораи зангзананда; каси дигар workspace_id ҳосилҳо 403.
  2. Тасдиқкунӣ талаб карда мешавад — як сессияи админ (куки) ё як 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 курсор. фаъол бозпайваст шавед, аз курсор бозӣ кунед то ҳадди ақал як маротиба расонидани ба шуморо кафолат диҳед истеъмолкунанда

Баъд ба куҷо