AiHummer
Eesti▾
SisselogimineKonto
v1.1.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/Sissetulevad ja integratsiooni käivitajad

Sissetulevad ja integratsiooni käivitajad

v1.1.x · uuendatud 2026-07-27

Lisaks OpenAI-ühilduvale API-le aktsepteerib AiHummer sissetulevad sõnumid ühendajatest ja automatiseerimisplatvormidest ning väljastab serveripoolne sündmuste voo neile saate tellida. Need lõpp-punktid on see, kuidas välised süsteemid toimetavad tööd gateway-le ja kuidas kasutajaliidesed püsivad aktiivsed.

Sissetulevad lõpp-punktid

Sissetulevad lõpp-punktid on viis, kuidas kanali ühendajad ja kohandatud integratsioonid edastavad sõnumi pöörlemismootorile. Neid kaitseb HMAC-i jagatud saladus saadetud sisse X-AIHummer-Inbound-Secret päis (see AIHUMMER_INBOUND_SECRET settings-catalog võti — seadistatud administraatori kasutajaliideses jaotises Haldus → Seaded või aihummer settings set, mitte sees gateway.env).

Meetod ja tee Eesmärk
POST /v1/inbound/telegram Telegrami kohalike sissetulevate andmepakettide andmed
POST /v1/inbound/generic Üldine sissetulev meili→veebikonveieri, cron-ülesannete ja kohandatud rakenduste jaoks
POST /v1/inbound/binding/status Teata kanali sidumise seisundist

See generiline lõpp-punkt on kõige lihtsam viis toita mis tahes allikat AiHummerisse. Saada väike JSON-keha koos kanali nime, stabiilse välishuvistatja ja sõnumi tekstiga:

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] Üldine sissetuleva liikumise edastaja vajab vaike tööala. Määra AIHUMMER_DEFAULT_WORKSPACE_ID nii et saab sissetulevaid sõnumeid suunata.

[!WARNING] Sissetulevad lõpp-punktid ei ole kaitstud ah- API võti — nad tuginevad sellele X-AIHummer-Inbound-Secret HMAC. Hoidke see saladus kliendipoolse koodi eest eemal ja Pööra seda, kui see lekib.

Integratsiooni käivitajad (Zapier / Make)

POST /v1/integrations/trigger on sisenemispunkt madala koodiga automatiseerimisplatvormidele, nagu Zapier ja Teha. Lõpp-punkt on vaikimisi keelatud: kuni AIHUMMER_INBOUND_TRIGGER_SECRET seadistus on konfigureeritud see reageerib 501 Not Implemented. See on eraldiseisev salajane, eristuv AIHUMMER_INBOUND_SECRET; nagu iga seadistuste kataloogi võti, on see määratud administraatori liideses (Haldamine → Seadistused) või aihummer settings set.

Kui see on seadistatud, aktsepteerib lõpp-punkt kas X-AIHummer-Signature HMAC või kandjatõend vormis 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 taustsüsteem

Need kaks marsruuti on lehe Admin Sessions jaoks säilitatud sisemine transpordikiht. Need ei ole toetatud kliendile suunatud manustatav kanal.

Meetod ja tee Otstarve
POST /v1/web/session Admin Sessions vestluse avamine või uuesti sidumine
GET /v1/web/stream Vestluse vastuse voogedastus SSE kaudu

Sündmuste voog

GET /v1/events/stream on taastatav Serveri saatetud sündmuste voo väravaga seotud sündmuste jaoks. Lõpp-punktil on kaks kohustuslikku nõuet:

  1. See ?workspace_id=<id> parameeter on kohustuslik — ilma selleta taotlus on tagasi lükatud koos 400. Üürniku valve kontrollib, et tööruum kuulub heliinaja üürnik; kellegi teise oma workspace_id saagis 403.
  2. Autentimine on vajalik — administraatori seanss (küpsis) või üks ah- API sisestada Authorization: Bearer päis. Ilma selleta on vastus 401.

Anna edasi ?since= kursor jätkamiseks sealt, kus eelmine ühendus pooleli jäi, nii et taasalustamine ei kaota kunagi sündmusi.

# 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] Käsitle iga sündmuse kandvat väärtust järgmisena since kursor. Sees ühenduda uuesti, mängida uuesti sellest kursorist, et tagada vähemalt kordne kohaletoimetamine teie tarbija.

Kuhu järgmine