მოსული და ინტეგრაციის ტრიგერები
OpenAI-სთან თავსებადი API-ს გარდა, AiHummer აღიქვამს მიღებული შეტყობინებები კონექტორებიდან და ავტომატიზაციის პლატფორმებიდან და გამოსხივებს ღონისძიებების ნაკადი სერვერის მხარეს რომელზეც შეგიძლიათ გამოწერა. ამ დასრულებადი წერტილებით გარე სისტემები გადაეცემიან მუშაობას გეითვეისთვის, ხოლო მომხმარებლის ინტერფეისები რჩებიან აქტიურები.
შემოსული ბოლო წერტილები
შემომავალი ბოლო წერტილებით არხების კონექტორები და სპეციალური ინტეგრაციები შეტყობინებებს დამუშავების ძრავაში გზავნიან. მათ იცავს X-AIHummer-Inbound-Secret სათაურით გადაცემული საერთო HMAC საიდუმლო (AIHUMMER_INBOUND_SECRET არის პარამეტრების კატალოგის გასაღები, რომელიც ადმინისტრაციული ინტერფეისის მართვა → პარამეტრები განყოფილებაში ან aihummer settings set ბრძანებით კონფიგურირდება და არა gateway.env-ში).
| მეთოდი და გზა | მიზანი |
|---|---|
POST /v1/inbound/telegram |
Telegram-ის შემომავალი სასარგებლო მონაცემები |
POST /v1/inbound/generic |
უნივერსალური შემომავალი ელ.ფოსტისთვის→ვებჰუკი, 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
ეს ორი endpoint შენარჩუნებულია Admin Sessions გვერდის შიდა ტრანსპორტად. ისინი არ არის მომხმარებლის საიტში ჩასაშენებელი მხარდაჭერილი არხი.
| მეთოდი და path | დანიშნულება |
|---|---|
POST /v1/web/session |
Admin Sessions დიალოგის გახსნა ან გაგრძელება |
GET /v1/web/stream |
დიალოგის პასუხის SSE-ით მიღება |
ობიექტების ნაკადი
GET /v1/events/stream არის გაგრძელებული სერვერიდან გაგზავნილი მოვლენების ნაკადი კარიბჭის მოვლენების შესახებ. ეს endpoint ორი აუცილებელი მოთხოვნა აქვს:
- ეს
?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_*პენები: გარემოს ცვლადები.