REST API
ChatReact REST API v1 suteikia programinę prieigą prie palaikomų valdymo skydelio operacijų: pokalbių robotų, žinių bazės ir krovimo, struktūruotų kainų, DUK, pokalbių peržiūros ir Improvement Agent, potencialių klientų, kontaktinių formų, tiesioginių pokalbių, įmonės ir komandos valdymo, Email Assistant, analizės ir pranešimų. Veiksmai, kuriems reikalingas naršyklės ryšys (mokėjimai, pašto dėžutės autorizacija, passkey'ai, paskyros ištrynimas ir API raktų valdymas) lieka valdymo skydelyje.
Labiau patinka bendrauti su AI asistentu? Tos pačios galimybės pasiekiamos kaip MCP įrankiai — žr. MCP Server Integration. Interaktyvus API Explorer su užklausų ir atsakymų schemomis prieinamas adresu /api-reference, kur taip pat galite atsisiųsti OpenAPI 3.0 specifikaciją.
Autentifikacija
- Eikite į Pagrindinis → Įmonė → API skirtuką ir spauskite Sukurti API raktą
- Pasirinkite pavadinimą ir reikalingas leidimų sritis (scopes) raktui (žr. žemiau)
- Nukopijuokite raktą — jis prasideda
cr_ir rodomas tik vieną kartą
Siųskite raktą su kiekvienu užklausimu:
curl https://www.chatreact.ai/api/v1/chatbots \
-H "Authorization: Bearer cr_your_api_key"
Priimamas ir X-API-Key: cr_your_api_key antraštė. API raktai priklauso vienai įmonei ir veikia su įmonės savininko leidimais; plano apribojimai ir funkcijų blokai taikomi taip pat, kaip valdymo skydelyje.
API prieiga yra prieinama mokamuose planuose — žr. Pricing page. Raktus bet kada galima atšaukti iš valdymo skydelio.
Leidimai (Scopes)
Kiekvienas raktas turi vieną ar daugiau leidimų sričių. Kai raktui trūksta reikiamo leidimo, galinis taškas grąžina 403.
| Scope | Grants |
|---|---|
chatbots:read / chatbots:write | Pokalbių roboto konfigūracija: asmenybė, kalbos, valdiklis (widget), elgsena, apribojimai, pagrindinės instrukcijos, įterpimo kodas, mokymosi fazė, pokalbių roboto šablonai, DUK valdiklio nustatymai |
knowledge:read / knowledge:write | Žinių bazė: dokumentai, svetainės kruizavimas (crawling), nuskaitytos puslapiai |
faqs:read / faqs:write | DUK, DUK kategorijos, pasiūlymai, vertimai |
chats:read / chats:write | Pokalbių istorija, pokalbių įvertinimai, pasitikėjimo kategorijos, tiesioginis pokalbis (agentų veiksmai reikalauja chats:write) |
leads:read / leads:write | Potencialūs klientai (leads), lead kategorijos, lead fiksavimo nustatymai, eksportas |
forms:read / forms:write | Kontaktinės formos ir pateikimai |
analytics:read | Statistika, veiklos serijos, piltuvėliai (funnels), pasitikėjimo būsena |
company:read / company:write | Įmonės profilis ir nustatymai, komandos nariai, kvietimai |
email:read / email:write | Email Assistant ryšiai, kategorijos, kontaktai, veikla |
prices:read | Skaityti struktūruotų kainų įrašus, versijas, tinkamumą ir pasiūlymus |
prices:write | Kurti ir redaguoti kainų juodraščius, importuoti CSV ir taikyti pasiūlymą kaip juodraštį; reikalauja įmonės savininko |
prices:approve | Patvirtinti tikslias versijas arba archyvuoti įrašus; reikalauja įmonės savininko |
blog:read / blog:write | Platformos tinklaraščio turinys (ChatReact vidinis) |
| any valid key | /v1/me, paskyros naudojimas, jūsų pranešimai |
Konvencijos
- Pagrindinis URL:
https://www.chatreact.ai/api/v1, JSON įėjimas ir išėjimas (Content-Type: application/json). - Atsakymai:
{ "success": true, "data": … }; sąrašai prideda"pagination": { "total", "page", "pageSize", "totalPages" }. NaudokitepageirpageSize(max 100) sąrašų endpointuose; kai kuriuose endpointuose siūloma kursoriaus (cursor) puslapiavimo tvarka (cursor/nextCursor). - Klaidos:
{ "success": false, "error": "message", "code": "BAD_REQUEST" }su neprivalomudetailsvalidacijos klaidoms. Būsenos kodai:400neteisingas įvestis,401trūksta arba neteisingas raktas,403trūksta leidimo, funkcija neįtraukta plane arba netinkama rolė,404resursas nerastas (taip pat resursams, priklausantiems kitoms įmonėms),409konfliktas,429viršytas ribojimas. - Dalininiai atnaujinimai:
PATCHendpointai keičia tik siųstus laukus; nežinomi laukai atmetami. - Ribojimas užklausų: 30 užklausų per minutę nuo vieno IP adreso.
- Ilgai trunkančios operacijos (kruizavimas, AI generavimas, vertimai) grąžina atsakymą greitai su darbu arba rezultatu, kurį galite periodiškai tikrinti; jos sunaudoja Jūsų plano token ir kruizavimo biudžetą.
Galiniai taškai
Prices & services
Išsaugojimas, redagavimas, importavimas ir pasiūlymo taikymas sukuria juodraščius be patvirtinimo. Patvirtinimo ir archyvavimo operacijos tikrina tikslias versijas; pasenusios versijos sukelia konfliktą. Esami raktai automatiškai negauna kainų leidimų. Tik įmonės savininkas gali suteikti rašymo arba patvirtinimo leidimus. Dėl kliento darbo eigos žr. Prices & services.
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/prices | Išvardinti kainų įrašus ir tinkamumą | prices:read |
POST | /api/v1/chatbots/{id}/prices | Sukurti juodraštį | prices:write |
GET | /api/v1/chatbots/{id}/prices/{itemId} | Skaityti detalę ir puslapiuotą istoriją | prices:read |
PATCH | /api/v1/chatbots/{id}/prices/{itemId} | Sukurti redaguotą juodraštį iš laukiamės versijos | prices:write |
GET | /api/v1/chatbots/{id}/prices/{itemId}/state | Skaityti pilną elemento būseną | prices:read |
POST | /api/v1/chatbots/{id}/prices/{itemId}/approve | Patvirtinti tikslią versiją | prices:approve |
POST | /api/v1/chatbots/{id}/prices/{itemId}/archive | Archyvuoti tikslią versiją | prices:approve |
POST | /api/v1/chatbots/{id}/prices/approve-many | Atominiu būdu patvirtinti aiškų versijos pasirinkimą | prices:approve |
POST | /api/v1/chatbots/{id}/prices/import | Importuoti CSV juodraščius su stabiliu import ID | prices:write |
GET | /api/v1/chatbots/{id}/prices/suggestions | Išvardinti kainų pasiūlymus | prices:read |
POST | /api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/apply | Pritaikyti pasirinktą pasiūlymą kaip juodraštį | prices:write |
Chatbots
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots | Išvardinti pokalbių robotus | chatbots:read |
POST | /api/v1/chatbots | Sukurti pokalbių robotą | chatbots:write |
GET | /api/v1/chatbots/{id} | Gauti pokalbių robotą | chatbots:read |
PATCH | /api/v1/chatbots/{id} | Atnaujinti pokalbių robotą | chatbots:write |
DELETE | /api/v1/chatbots/{id} | Ištrinti pokalbių robotą | chatbots:write |
GET | /api/v1/chatbots/{id}/personality | Gauti pokalbių roboto asmenybę | chatbots:read |
PATCH | /api/v1/chatbots/{id}/personality | Atnaujinti pokalbių roboto asmenybę | chatbots:write |
GET | /api/v1/chatbots/{id}/widget | Gauti valdiklio (widget) nustatymus | chatbots:read |
PATCH | /api/v1/chatbots/{id}/widget | Atnaujinti valdiklio nustatymus | chatbots:write |
GET | /api/v1/chatbots/{id}/widget/translations | Gauti valdiklio vertimus | chatbots:read |
PUT | /api/v1/chatbots/{id}/widget/translations | Pakeisti valdiklio vertimus | chatbots:write |
GET | /api/v1/chatbots/{id}/embed | Gauti įterpimo kodą | chatbots:read |
POST | /api/v1/chatbots/{id}/embed/confirm | Patvirtinti įterpimą | chatbots:write |
GET | /api/v1/chatbots/{id}/learning-phase | Gauti mokymosi fazės nustatymus | chatbots:read |
PATCH | /api/v1/chatbots/{id}/learning-phase | Atnaujinti mokymosi fazės nustatymus | chatbots:write |
POST | /api/v1/chatbots/{id}/learning-phase/end | Baigti mokymosi fazę | chatbots:write |
GET | /api/v1/chatbots/{id}/instructions | Išvardinti pagrindines instrukcijas | chatbots:read |
POST | /api/v1/chatbots/{id}/instructions | Pridėti pagrindinę instrukciją | chatbots:write |
PUT | /api/v1/chatbots/{id}/instructions/reorder | Perdėlioti pagrindines instrukcijas | chatbots:write |
POST | /api/v1/chatbots/{id}/instructions/improve | Patobulinti instrukcijas su AI | chatbots:write |
GET | /api/v1/instructions/{id} | Gauti pagrindinę instrukciją | chatbots:read |
PATCH | /api/v1/instructions/{id} | Atnaujinti pagrindinę instrukciją | chatbots:write |
DELETE | /api/v1/instructions/{id} | Ištrinti pagrindinę instrukciją | chatbots:write |
GET | /api/v1/chatbot-templates | Išvardinti pokalbių robotų šablonus | chatbots:read |
Knowledge base
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/knowledge | Žinių bazės apžvalga | knowledge:read |
GET | /api/v1/chatbots/{id}/documents | Išvardinti dokumentus pokalbių robotui | knowledge:read |
POST | /api/v1/chatbots/{id}/documents | Įkelti dokumentą | knowledge:write |
POST | /api/v1/chatbots/{id}/documents/presign | Paruošti dokumento įkėlimui (presign) | knowledge:write |
GET | /api/v1/documents/{id} | Gauti dokumentą | knowledge:read |
DELETE | /api/v1/documents/{id} | Ištrinti dokumentą | knowledge:write |
POST | /api/v1/documents/{id}/confirm | Patvirtinti presigned įkėlimą | knowledge:write |
GET | /api/v1/chatbots/{id}/crawl/limits | Kruizavimo (crawl) limitai | knowledge:read |
POST | /api/v1/chatbots/{id}/crawl/preview | Peržiūra nuskaitymui svetainės | knowledge:write |
GET | /api/v1/chatbots/{id}/crawl | Išvardinti kruizavimo darbus | knowledge:read |
POST | /api/v1/chatbots/{id}/crawl | Pradėti kruizavimą | knowledge:write |
GET | /api/v1/crawl-jobs/{jobId} | Gauti kruizavimo darbą | knowledge:read |
POST | /api/v1/crawl-jobs/{jobId}/cancel | Atšaukti kruizavimo darbą | knowledge:write |
GET | /api/v1/chatbots/{id}/pages | Išvardinti nuskaitytus puslapius | knowledge:read |
POST | /api/v1/chatbots/{id}/pages | Pridėti vieną URL | knowledge:write |
POST | /api/v1/chatbots/{id}/pages/bulk-delete | Masinis ištrynimas nuskaitytų puslapių | knowledge:write |
GET | /api/v1/pages/{id} | Gauti nuskaitytą puslapį | knowledge:read |
DELETE | /api/v1/pages/{id} | Ištrinti nuskaitytą puslapį | knowledge:write |
POST | /api/v1/pages/{id}/recrawl | Pakartotinai nuskaityti puslapį | knowledge:write |
GET | /api/v1/chatbots/{id}/websites | Išvardinti nuskaitytas svetaines | knowledge:read |
DELETE | /api/v1/chatbots/{id}/websites/{domain} | Ištrinti svetainę | knowledge:write |
POST | /api/v1/chatbots/{id}/websites/{domain}/recrawl | Pakartotinai nuskaityti svetainę | knowledge:write |
POST | /api/v1/chatbots/{id}/websites/{domain}/recrawl/cancel | Atšaukti svetainės pakartotinį nuskaitymą | knowledge:write |
DUK (FAQs)
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/faqs | Išvardinti DUK pokalbių robotui | faqs:read |
POST | /api/v1/chatbots/{id}/faqs | Sukurti DUK | faqs:write |
POST | /api/v1/chatbots/{id}/faqs/bulk | Masinis DUK importas | faqs:write |
POST | /api/v1/chatbots/{id}/faqs/reorder | Perdėlioti DUK | faqs:write |
GET | /api/v1/chatbots/{id}/faqs/embed | Gauti DUK valdiklio įterpimo kodą | chatbots:read |
POST | /api/v1/chatbots/{id}/faqs/purge-cache | Išvalyti nuotolines DUK talpyklas | faqs:write |
GET | /api/v1/faqs/{id} | Gauti DUK | faqs:read |
PATCH | /api/v1/faqs/{id} | Atnaujinti DUK | faqs:write |
DELETE | /api/v1/faqs/{id} | Ištrinti DUK | faqs:write |
PUT | /api/v1/faqs/{id}/translations | Atnaujinti DUK vertimus | faqs:write |
POST | /api/v1/faqs/{id}/translate | AI-vertimas DUK | faqs:write |
GET | /api/v1/chatbots/{id}/faq-suggestions | Išvardinti DUK pasiūlymus | faqs:read |
POST | /api/v1/chatbots/{id}/faq-suggestions/generate | Generuoti DUK pasiūlymus iš žinių bazės | faqs:write |
GET | /api/v1/faq-suggestions/{id} | Gauti DUK pasiūlymą | faqs:read |
POST | /api/v1/faq-suggestions/{id}/approve | Patvirtinti DUK pasiūlymą | faqs:write |
POST | /api/v1/faq-suggestions/{id}/reject | Atmesti DUK pasiūlymą | faqs:write |
GET | /api/v1/chatbots/{id}/faq-categories | Išvardinti DUK kategorijas | faqs:read |
POST | /api/v1/chatbots/{id}/faq-categories | Sukurti DUK kategoriją | faqs:write |
POST | /api/v1/chatbots/{id}/faq-categories/reorder | Perdėlioti DUK kategorijas | faqs:write |
GET | /api/v1/faq-categories/{id} | Gauti DUK kategoriją | faqs:read |
PATCH | /api/v1/faq-categories/{id} | Atnaujinti DUK kategoriją | faqs:write |
DELETE | /api/v1/faq-categories/{id} | Ištrinti DUK kategoriją | faqs:write |
PUT | /api/v1/faq-categories/{id}/translations | Atnaujinti DUK kategorijos vertimus | faqs:write |
GET | /api/v1/chatbots/{id}/faq-widget-settings | Gauti DUK valdiklio nustatymus | chatbots:read |
PATCH | /api/v1/chatbots/{id}/faq-widget-settings | Atnaujinti DUK valdiklio nustatymus | chatbots:write |
Pokalbiai, atsiliepimai ir Improvement Agent
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chats | Išvardinti pokalbių sesijas | chats:read |
GET | /api/v1/chats/{sessionId} | Gauti pokalbio sesiją | chats:read |
PATCH | /api/v1/chats/{sessionId} | Nustatyti pokalbio pasitikėjimo kategoriją | chats:write |
POST | /api/v1/chats/{sessionId}/feedback | Įvertinti pokalbį (Good / Needs Work) | chats:write |
POST | /api/v1/chats/{sessionId}/feedback/dismiss | Atmesti pokalbio peržiūrą | chats:write |
POST | /api/v1/chats/{sessionId}/improve | Pradėti Improvement Agent pokalbiui | chatbots:write |
GET | /api/v1/chatbots/{id}/feedback | Išvardinti pokalbių peržiūras konkrečiam pokalbių robotui | chats:read |
GET | /api/v1/chatbots/{id}/feedback/stats | Pokalbių peržiūros statistikos kortelės | chats:read |
GET | /api/v1/feedback/{id} | Gauti pokalbio peržiūrą | chats:read |
PATCH | /api/v1/feedback/{id} | Pakeisti peržiūros rimtumą (override) | chats:write |
POST | /api/v1/feedback/{id}/improvement-session | Pradėti Improvement Agent peržiūrai | chatbots:write |
GET | /api/v1/chatbots/{id}/confidence | Gauti pasitikėjimo būseną | analytics:read |
GET | /api/v1/chatbots/{id}/confidence-categories | Išvardinti pasitikėjimo kategorijas | chats:read |
POST | /api/v1/chatbots/{id}/confidence-categories | Sukurti pasitikėjimo kategoriją | chatbots:write |
PATCH | /api/v1/confidence-categories/{id} | Atnaujinti pasitikėjimo kategoriją | chatbots:write |
DELETE | /api/v1/confidence-categories/{id} | Ištrinti pasitikėjimo kategoriją | chatbots:write |
POST | /api/v1/confidence-categories/{id}/merge | Sulieti pasitikėjimo kategorijas | chatbots:write |
GET | /api/v1/chatbots/{id}/improvement-sessions | Išvardinti tobulinimo sesijas | chatbots:read |
GET | /api/v1/improvement-sessions/{id} | Gauti tobulinimo sesiją | chatbots:read |
POST | /api/v1/improvement-sessions/{id}/messages | Siųsti žinutę Improvement Agent | chatbots:write |
POST | /api/v1/improvement-sessions/{id}/complete | Pabaigti tobulinimo sesiją | chatbots:write |
POST | /api/v1/improvement-sessions/{id}/reset | Atstatyti tobulinimo sesiją | chatbots:write |
POST | /api/v1/improvement-proposals/{id}/apply | Pritaikyti tobulinimo pasiūlymą | chatbots:write |
POST | /api/v1/improvement-proposals/{id}/reject | Atmesti tobulinimo pasiūlymą | chatbots:write |
POST | /api/v1/improvement-proposals/{id}/simulations | Simuliuoti tobulinimo pasiūlymą | chatbots:write |
POST | /api/v1/improvement-simulations/{id}/assessment | Įvertinti simuliacijos rezultatą | chatbots:write |
Potencialūs klientai (Leads)
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/leads | Išvardinti lead'us | leads:read |
POST | /api/v1/leads | Sukurti lead'ą | leads:write |
GET | /api/v1/leads/{id} | Gauti lead'ą | leads:read |
PATCH | /api/v1/leads/{id} | Atnaujinti lead'ą | leads:write |
DELETE | /api/v1/leads/{id} | Ištrinti lead'ą | leads:write |
POST | /api/v1/leads/{id}/assign | Priskirti lead'ą | leads:write |
POST | /api/v1/leads/bulk-status | Masinis lead būsenos atnaujinimas | leads:write |
GET | /api/v1/leads/stats | Lead statistika | leads:read |
GET | /api/v1/leads/export | Eksportuoti lead'us | leads:read |
GET | /api/v1/chatbots/{id}/lead-config | Gauti lead fiksavimo konfigūraciją | leads:read |
PUT | /api/v1/chatbots/{id}/lead-config | Atnaujinti lead fiksavimo konfigūraciją | leads:write |
GET | /api/v1/chatbots/{id}/lead-categories | Išvardinti lead kategorijas | leads:read |
POST | /api/v1/chatbots/{id}/lead-categories | Sukurti lead kategoriją | leads:write |
GET | /api/v1/lead-categories/{id} | Gauti lead kategoriją | leads:read |
PATCH | /api/v1/lead-categories/{id} | Atnaujinti lead kategoriją | leads:write |
DELETE | /api/v1/lead-categories/{id} | Ištrinti lead kategoriją | leads:write |
PUT | /api/v1/lead-categories/{id}/users/{userId} | Priskirti narį prie lead kategorijos | leads:write |
DELETE | /api/v1/lead-categories/{id}/users/{userId} | Pašalinti narį iš lead kategorijos | leads:write |
Kontaktinės formos
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/forms | Išvardinti kontaktines formas | forms:read |
POST | /api/v1/chatbots/{id}/forms | Sukurti kontaktinę formą | forms:write |
GET | /api/v1/forms/{id} | Gauti kontaktinę formą | forms:read |
PATCH | /api/v1/forms/{id} | Atnaujinti kontaktinę formą | forms:write |
DELETE | /api/v1/forms/{id} | Ištrinti kontaktinę formą | forms:write |
GET | /api/v1/forms/{id}/submissions | Išvardinti formos pateikimus | forms:read |
GET | /api/v1/forms/{id}/stats | Formos pateikimų statistika | forms:read |
GET | /api/v1/submissions/{id} | Gauti formos pateikimą | forms:read |
PATCH | /api/v1/submissions/{id} | Peržiūrėti formos pateikimą | forms:write |
DELETE | /api/v1/submissions/{id} | Ištrinti formos pateikimą | forms:write |
Tiesioginiai pokalbiai (Live chat)
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/live-chat/availability | Gauti savo tiesioginio pokalbio būseną | chats:read |
PUT | /api/v1/live-chat/availability | Nustatyti savo tiesioginio pokalbio būseną | chats:write |
POST | /api/v1/live-chat/heartbeat | Siųsti presence heartbeat | chats:write |
GET | /api/v1/live-chat/agents | Išvardinti prieinamus tiesioginio pokalbio agentus | chats:read |
GET | /api/v1/live-chat/sessions | Išvardinti tiesioginio pokalbio sesijas | chats:read |
GET | /api/v1/live-chat/sessions/{sessionId} | Gauti tiesioginio pokalbio sesiją | chats:read |
POST | /api/v1/live-chat/sessions/{sessionId}/assign | Prisiimti tiesioginį pokalbį (priskirti raktą savininkui) | chats:write |
POST | /api/v1/live-chat/sessions/{sessionId}/messages | Siųsti žinutę kaip agentas | chats:write |
POST | /api/v1/live-chat/sessions/{sessionId}/close | Baigti tiesioginį pokalbį | chats:write |
Analitika
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/analytics | Gauti analitikos apžvalgą | analytics:read |
GET | /api/v1/analytics/activity | Gauti pokalbių veiklos serijas | analytics:read |
GET | /api/v1/analytics/chatbots | Išvardinti pagal pokalbių robotą našumo statistiką | analytics:read |
GET | /api/v1/analytics/chatbots/{id} | Gauti pokalbių roboto analizę | analytics:read |
GET | /api/v1/analytics/leads | Gauti lead piltuvėlį (funnel) | analytics:read |
GET | /api/v1/analytics/forms | Gauti formos pateikimų statistiką | analytics:read |
GET | /api/v1/activity | Gauti dėmesio santrauką (attention summary) | analytics:read |
Įmonė ir komanda
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/company | Gauti įmonę | any key |
PATCH | /api/v1/company | Atnaujinti įmonę | company:write |
GET | /api/v1/company/settings | Gauti įmonės nustatymus | company:read |
PATCH | /api/v1/company/settings | Atnaujinti įmonės nustatymus | company:write |
DELETE | /api/v1/company/logo | Pašalinti įmonės logotipą | company:write |
GET | /api/v1/company/members | Išvardinti komandos narius | company:read |
PATCH | /api/v1/company/members/{userId} | Pakeisti nario rolę | company:write |
DELETE | /api/v1/company/members/{userId} | Pašalinti komandos narį | company:write |
GET | /api/v1/company/invites | Išvardinti kvietimus | company:read |
POST | /api/v1/company/invites | Pakviesti komandos narį | company:write |
DELETE | /api/v1/company/invites/{id} | Atšaukti kvietimą | company:write |
POST | /api/v1/company/invites/{id}/resend | Persiųsti kvietimą | company:write |
Email Assistant
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/email/connections | Išvardinti pašto dėžučių ryšius | email:read |
GET | /api/v1/email/connections/{id} | Gauti pašto dėžutės ryšį | email:read |
PATCH | /api/v1/email/connections/{id} | Atnaujinti pašto dėžutės ryšį | email:write |
DELETE | /api/v1/email/connections/{id} | Atsijungti nuo pašto dėžutės | email:write |
GET | /api/v1/email/connections/{id}/categories | Išvardinti el. pašto kategorijas | email:read |
POST | /api/v1/email/connections/{id}/categories | Sukurti el. pašto kategoriją | email:write |
GET | /api/v1/email/connections/{id}/folders | Išvardinti pašto aplankus | email:read |
POST | /api/v1/email/connections/{id}/folders | Sukurti pašto aplanką | email:write |
GET | /api/v1/email/connections/{id}/activity | Išvardinti el. pašto veiklos žurnalą | email:read |
GET | /api/v1/email/categories/{id} | Gauti el. pašto kategoriją | email:read |
PATCH | /api/v1/email/categories/{id} | Atnaujinti el. pašto kategoriją | email:write |
DELETE | /api/v1/email/categories/{id} | Ištrinti el. pašto kategoriją | email:write |
GET | /api/v1/email/contacts | Išvardinti el. pašto kontaktus | email:read |
GET | /api/v1/email/contacts/{id} | Gauti el. pašto kontaktą | email:read |
PATCH | /api/v1/email/contacts/{id} | Atnaujinti el. pašto kontaktą | email:write |
DELETE | /api/v1/email/contacts/{id} | Ištrinti el. pašto kontaktą | email:write |
Paskyra ir pranešimai
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/me | Gauti rakto kontekstą (whoami) | any key |
GET | /api/v1/account/usage | Gauti planą ir naudojimą | any key |
GET | /api/v1/notifications | Išvardinti pranešimus | any key |
DELETE | /api/v1/notifications | Ištrinti senus perskaitytus pranešimus | any key |
GET | /api/v1/notifications/unread-count | Gauti neperskaitytų pranešimų skaičių | any key |
POST | /api/v1/notifications/mark-all-read | Pažymėti visus pranešimus kaip perskaitytus | any key |
GET | /api/v1/notifications/{id} | Gauti pranešimą | any key |
PATCH | /api/v1/notifications/{id} | Pažymėti pranešimą kaip perskaitytą | any key |
Tinklaraštis (platforma)
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/blog | Išvardinti tinklaraščio įrašus | any key |
POST | /api/v1/blog | Sukurti tinklaraščio įrašą | any key |
POST | /api/v1/blog/assets | Įkelti tinklaraščio turtą | any key |
GET | /api/v1/blog/{id} | Gauti tinklaraščio įrašą | any key |
PATCH | /api/v1/blog/{id} | Atnaujinti tinklaraščio įrašą | any key |
DELETE | /api/v1/blog/{id} | Ištrinti tinklaraščio įrašą | any key |
POST | /api/v1/blog/{id}/translations | Eilėje vertimai tinklaraščiui | any key |
Reikia pagalbos? Susisiekite su mūsų palaikymo komanda →