AiHummer
Lietuvių▾
PrisijungtiPaskyra
v1.0.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/Įeinantys ir integracijos suveikimo signalai

Įeinantys ir integracijos suveikimo signalai

v1.0.x · atnaujinta 2026-07-27

Be OpenAI suderinamo API, AiHummer priima įeinantys pranešimai iš jungčių ir automatizavimo platformų, ir skleidžia serverio pusės įvykių srautas jums galima užsiprenumeruoti. Šie galutiniai taškai yra būdas, kaip išorinės sistemos perduoda darbą į vartus ir kaip Vartotojo sąsajos lieka veiksnios.

Įeinantieji galiniai taškai

Įeinantys galiniai taškai yra tai, kaip kanalo jungtys ir pritaikyti integracijos perduoda žinutę perjungimo varikliui. Jie yra apsaugoti HMAC bendras slaptasis raktas išsiųsta į X-AIHummer-Inbound-Secret antraštė (tas AIHUMMER_INBOUND_SECRET settings-catalog raktas — sukonfigūruotas administratoriaus sąsajoje pagal Valdymas → Nustatymai arba naudojant aihummer settings set, ne gateway.env).

Metodas ir kelias Tikslas
POST /v1/inbound/telegram Gimtosios „Telegram“ įeinančios užklausos
POST /v1/inbound/generic Bendras įeinantis el. paštui → webhook, cron ir individualioms programoms
POST /v1/inbound/binding/status Pranešti apie kanalo sujungimo būseną

Tas bendra galinis taškas yra paprasčiausias būdas perduoti bet kurį šaltinį į AiHummer. Siųskite nedidelį JSON kūną su kanalo pavadinimu, stabiliu išoriniu identifikatoriumi ir žinutės tekstu:

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] Bendras įeinančių užduočių paskirstytojas turi turėti numatytąją darbo vietą. Nustatyti AIHUMMER_DEFAULT_WORKSPACE_ID taigi gaunami pranešimai gali būti nukreipiami.

[!WARNING] Įeinantys galutiniai taškai nėra apsaugoti nuo ah- API raktas — jie remiasi tuo X-AIHummer-Inbound-Secret HMAC. Laikykite tą slaptažodį atokiai nuo kliento pusės kodo ir pasukite jį, jei jis lekia.

Integracijos sukelėjai (Zapier / Make)

POST /v1/integrations/trigger yra įėjimo taškas žemo kodo automatizavimo platformoms, tokioms kaip Zapier ir Padaryti. Galutinis taškas yra pagal numatytuosius nustatymus išjungta: iki AIHUMMER_INBOUND_TRIGGER_SECRET nustatymas sukonfigūruotas, jis atsako su 501 Not Implemented. Tai yra atskirti paslaptingas, skirtingas nuo AIHUMMER_INBOUND_SECRET; kaip ir kiekvienas settings-catalog raktas, jis nustatomas administravimo sąsajoje (Valdymas → Nustatymai) arba su aihummer settings set.

Kai nustatytas, galinis taškas priima arba X-AIHummer-Signature HMAC arba nešėjo žetonas tokia forma 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 posistemė

Šie du maršrutai yra vidinis perdavimo mechanizmas, paliktas puslapiui Admin Sessions. Jie nėra palaikomas klientams skirtas įterpiamasis kanalas.

Metodas ir kelias Paskirtis
POST /v1/web/session Atverti arba iš naujo susieti Admin Sessions pokalbį
GET /v1/web/stream Srautiniu būdu siųsti pokalbio atsakymą per SSE

Įvykių srautas

GET /v1/events/stream yra galintis būti tęsiamas Vartų įvykių serverio siunčiamų įvykių srautas. Galutinis taškas turi dvi griežtas reikalavimus:

  1. Tas ?workspace_id=<id> parametras yra privalomas — be jos prašymas atmetamas su 400. Nuomininko apsauga patikrina, ar darbo sritis priklauso skambinančiojo nuomininkas; kieno nors kito workspace_id derlius 403.
  2. Reikalinga autentifikacija — administratoriaus seansas (sausainėlis) arba ah- API įvesti Authorization: Bearer antraštė. Be jos atsakymas yra 401.

Perduoti ?since= žymeklis tęsti nuo ten, kur baigėsi ankstesnis ryšys, todėl pakartotinis prisijungimas niekada nepraranda įvykių.

# 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] Laikykite kiekvienos renginio perduodamos vertės kaip kitą since žymeklis. Įjungta vėl prisijungti, paleisti iš naujo nuo to žymeklio, kad garantuotumėte bent vieną pristatymą jūsų vartotojas.

Kur toliau