Մուտքային և ինտեգրացիոն զանգեր
Բացի 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 |
Համընդհանուր ներգնա համար էլեկտրոնային փոստի, webhook-ի, 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-SecretHMAC. Ապահովեք, որ այս գաղտնիքը հեռու մնա հաճախորդի կողմի կոդից և Պտտեցրեք այն, եթե այն արտահոսում է։
Ինտեգրման գործարկիչներ (Zapier / Make)
POST /v1/integrations/trigger համարվում է ցածր կոդով ավտոմատացման հարթակների մուտքի կետը, ինչպիսիք են Զափյեր և Կատարել. Ապահով կետը հանդիսանում է պայմանավորվածությամբ անջատված: մինչև AIHUMMER_INBOUND_TRIGGER_SECRET ներբեռնումը կազմված է, այն պատասխանում է 501 Not Implemented. Սա տարբեր գաղտնի, տարբերվող AIHUMMER_INBOUND_SECRET; ինչպես նաև յուրաքանչյուր կարգաբանի պարամետրերի բանալին, այն կարգավորվում է ադմինիստրատիվ միջերեսում (Կառավարում → Պարամետրեր) կամ օգտագործելով aihummer settings set.
Կարգավորումներից հետո վերջային կետը ընդունում է կամ X-AIHummer-Signature HMAC կամ մուտքի նշան տեսակի 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 էջի ներքին տրանսպորտ։ Դրանք հաճախորդի կայքում ներդրվող աջակցվող ալիք չեն։
| Մեթոդ և path | Նպատակ |
|---|---|
POST /v1/web/session |
Բացել կամ շարունակել Admin Sessions զրույցը |
GET /v1/web/stream |
Ստանալ զրույցի պատասխանը որպես SSE |
Պատահարների հոսք
GET /v1/events/stream է շարունակվող Գրծվող իրադարձությունների հոսք, որը նետվում է սերվերի կողմից: Այս վերջնակետը ունի երկու խիստ պահանջներ:
- Այս
?workspace_id=<id>պարամետրը պարտադիր է — առանց այս հարցման հեռանում է՝400. Օկուպանտի պահակը ստուգում է, որ աշխատանքային տարածքը պատկանում է զանգող վարձակալը; ինչ-որ մեկ ուրիշիworkspace_idտարածք403. - Պահանջվում է նույնականացում — ադմինիստրատորի նստաշրջան (քուկի) կամ
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կուրսոր. Ներմուծված նորից միանալ, նվագարկել նշված կուրսորից, որպեսզի երաշխավորվի առնվազն մեկ անգամ ձեր հասցեին ինֆորմացիայի առաքումը գործարանատարող
Որտեղից հետո
- Տեքստը շրջում է OpenAI-ի մակերեսը: Չաթի ավարտ.
- Դիմումների միացում, SSO ֆեդերացիա և պրոտոկոլային ինտերֆեյսներ: Վեբհուքեր, SCIM և համակցում.
- Համենայն
AIHUMMER_*ձեռքեր: Շրջակա միջավայրի փոփոխականներ.