Skip to content

SMSBAT ChatHub API

Bainistíonn ChatHub REST API comhráite gnó Viber, comhráite cliant, agus sreafaí oibre uathoibrithe tacaíochta custaiméara.

Bun-URL

_CÓD_BLOCK_0__

Doiciméadúchán Swagger

Tá doiciméadú idirghníomhach API ar fáil ag:

_CÓD_BLOCK_1__

Fíordheimhniú

Úsáideann ChatHub córas fíordheimhnithe bunaithe ar chomharthaí Bearer le comharthaí JWT. Is féidir comharthaí a chur ar aghaidh ar dhá bhealach:

Modh 1: Ceanntásc Údaraithe

_CÓD_BLOCK_2__

Modh 2: Ceanntásc X-Údarú-Eochair

_CÓD_BLOCK_3__

Sreabhadh Fíordheimhnithe

Úsáideann ChatHub córas comharthaíochta dhá leibhéal:

  1. ** Chomhartha Cuideachta** - Comhartha rochtana ar leibhéal na heagraíochta
  2. ** Chomhartha Oibreora** - Comhartha rochtana oibritheora aonair

Sreabhadh Oibre

_CÓD_BLOCK_4__

Príomhphointí Deiridh

Modh Críochphointe Cur Síos
POST /api/cuideachta/get-token Faigh chomhartha údaraithe cuideachta
FAIGH /api/cuideachta/eagraíocht Aisghabh liosta eagraíochta
FAIGH /api/oibreoir Liostaigh oibreoirí de réir eagraíochta
POST /api/oibreoir/sioncrónaigh Cuir oibreoirí nua leis
POST /api/oibreoir/stádas Athraigh stádas oibreora
POST /api/operator/get-token Gin comharthaí oibreora (24h ar a mhéad)
POST /api/operator/validate-token Fíoraigh bailíocht an chomhartha

Príomhghnéithe

Bainistíocht Chomhartha na Cuideachta

Faigh agus bainistigh comharthaí ar leibhéal na heagraíochta le haghaidh rochtain API.

Bainistíocht Eagraíochta

  • Liostaigh na heagraíochtaí go léir
  • Aisghabh sonraí eagraíochta
  • Bainistigh socruithe eagraíochta

Bainistíocht Oibreora

  • Liostaigh oibreoirí de réir eagraíochta
  • Cuir oibreoirí nua leis
  • Athraigh stádas oibreora (Gníomhach/Neamhghníomhach/Scriostha)
  • Gin comharthaí a bhaineann go sonrach leis an oibreoir (24 uair an chloig ar a mhéad)
  • Deimhnigh comharthaí oibreora

Comhtháthú Giuirléid

Comhtháthaigh giuirléid ChatHub le feidhmchláir ghréasáin le haghaidh tacaíocht fíor-ama do chustaiméirí.

Tús Tapa

  1. Fíordheimhniú - Faigh comharthaí do chuideachta agus d'oibreoir
  2. Eagraíochtaí - Bainistigh eagraíochtaí
  3. Oibreoirí - Cuir leis agus bainistigh oibreoirí
  4. Comhtháthú Giuirléid - Comhtháthaigh an ghiuirléid chomhrá

Formáid Iarratas

Úsáideann gach iarratas formáid JSON:

_CÓD_BLOCK_5__

Formáid Freagartha

Freagraí rathúla ar ais:

_CÓD_BLOCK_6__

Láimhseáil Earráide

Cóid stádais HTTP:

  • 200 OK - D'éirigh leis an iarratas
  • 400 Drochiarratas - Formáid iarratais neamhbhailí
  • 401 Neamhúdaraithe - Theip ar fhíordheimhniú
  • 403 Toirmiscthe - Ceadanna neamhleor
  • 404 Gan Aimsiú - Ní bhfuarthas an acmhainn
  • Earráid Freastalaí Inmheánach 500 - Earráid fhreastalaí

Éaga Chomhartha

Tá am éaga ag comharthaí. Nuair a théann comhartha in éag:

  1. Tabharfaidh an API ar ais 401 Neamhúdaraithe
  2. Iarr comhartha nua ag baint úsáide as an críochphointe fíordheimhnithe
  3. Nuashonraigh d'iarratas leis an comhartha nua

Na Chéad Chéimeanna Eile