AiHummer
Монгол▾
НэвтрэхБүртгэл
v1.1.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/Орох ба Интеграцийн Идэвхжүүлэгчид

Орох ба Интеграцийн Идэвхжүүлэгчид

v1.1.x · шинэчилсэн 2026-07-27

OpenAI-тэй нийцсэн API-аас гадна, AiHummer хүлээн авдаг оролттой зурвасууд холбогч ба автоматжуулалтын платформоос, мөн гаргадаг сервер талын үйл явдлын урсгал Та үүнд захиалга өгч болно. Эдгээр төгсгөлүүд нь гадаад системүүд ажлыг гарцад хэрхэн өгдөг ба хэрэглэгчийн интерфэйсүүд хэрхэн амьд байгааг хадгалдаг болохыг хэлнэ.

Орох төгсгөлүүд

Орж ирж буй төгсгөлийн цэгүүд нь сувгийн холбогч болон захиалгат интеграцууд мессежийг эргэлтийн хөдөлгүүрт хэрхэн өгдгийг тодорхойлдог. Тэдгээрийг X-AIHummer-Inbound-Secret толгой хэсгээр илгээдэг HMAC хуваалцсан нууц хамгаална (AIHUMMER_INBOUND_SECRET нь тохиргооны каталогийн түлхүүр бөгөөд Админ интерфэйсийн Management → Settings хэсэгт эсвэл aihummer settings set командаар тохируулна; gateway.env-д биш).

Арга ба зам Зорилго
POST /v1/inbound/telegram Telegram-ийн угийн орж ирж буй өгөгдлийн багц
POST /v1/inbound/generic Имэйл→вебхүүк, cron ба өөрийн апп-д зориулсан ерөнхий inbound
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 түлхүүрүүдийн адил энэ нь админ UI-д (Удирдлага → Тохиргоо) эсвэл ашиглан тохируулсан байдаг 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 арын хэсэг

Эдгээр хоёр маршрут нь 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 курсор. асаалттай эргэлдэн нэвтрэх, тэр курсороос дахин тоглуулах, таны хүлээлгэх хүргэхийг дор хаяж нэг удаа баталгаажуулахын тулд хэрэглэгч

Дараа хаашаа явах вэ