API аутентификациясы

Chato REST API жұмыс кеңістігінің API-кілті арқылы аутентификацияланады — бұл браузердегі жеке сессияңыздан бөлек. Кілт жұмыс кеңістігі иесінің атынан әрекет етеді және REST API-ге толық қолжетімділік береді.

Кілтті алу

Кілт жеке кабинетте жасалады: Баптаулар → API-кілт → «Жасау». Chato шикі кілтті тек бір рет, жасалғаннан кейін бірден көрсетеді — оны бірден сақтаңыз, қайта көру мүмкін емес. Кілтті қайта шығару алдыңғысын дереу жарамсыз етеді: ескі кілтті пайдаланатын кез келген интеграция жұмыс істемей қалады.

Негізгі мекенжай

https://chato.kz/api/v1

Қалай пайдалану керек

Кілтті әр сұраныста Authorization тақырыбында жіберіңіз:

GET /workspaces
Authorization: Bearer chato_sk_...

Бұл сұраныс жұмыс кеңістіктеріңізді олардың id-сімен бірге қайтарады — ол дерлік барлық басқа сұраныстарда :workspaceId ретінде қажет болады.

Негізгі эндпоинттер

Арналар тізімі:

GET /workspaces/:workspaceId/channels

Диалогтар тізімі (сүзгілер: status, assigned=me|none, cursor/limit арқылы парақтау):

GET /workspaces/:workspaceId/conversations?status=OPEN&limit=30

Белгілі бір арнада жаңа нөмірмен диалог бастау:

POST /workspaces/:workspaceId/conversations/start
Content-Type: application/json

{ "channelId": "clx...", "phone": "77011234567" }

Диалог хабарламалары:

GET /workspaces/:workspaceId/conversations/:conversationId/messages

Хабарлама жіберу:

POST /workspaces/:workspaceId/conversations/:conversationId/messages
Content-Type: application/json

{ "content": "Сәлеметсіз бе!" }

Шектеулер

Кілт кабинетте қолмен жойылмайынша жарамды болып қалады. Оның браузердің JWT-сессиясынан айырмашылығы — өз мерзімі жоқ, оны тек кабинетте жою немесе қайта шығару арқылы ғана өшіруге болады.