https://api.my-doc.kz/api/Передайте токен подписчика в заголовке Authorization (без префикса Bearer).
GET /api/branches
Authorization: <ваш токен>
Ограничение частоты запросов: не более одного запроса к API в 2 секунды.
200 OK — Запрос успешно выполнен (в т.ч. когда ресурс не найден: IsSuccess=false в теле).401 Unauthorized — Нет заголовка Authorization или токен неверный.403 Forbidden — У подписчика нет доступных филиалов.404 Not Found — Данные не найдены или нет прав на просмотр.405 Method Not Allowed — Метод не поддерживается (заголовок Allow).500 Internal Server Error — Ошибка БД или сервера.
Все временные метки в API передаются и принимаются в часовом поясе
Asia/Almaty (UTC+5) без указания смещения в строке.
Формат даты и времени для last_update_time и параметра update_after - YYYY-MM-DD HH:MM:SS.
Суффиксы Z и +05:00 не принимаются
{
"IsSuccess": true,
"Error": null,
"Data": { ... },
"Pagination": { ... }
}
{
"IsSuccess": false,
"Error": "string",
"Data": null,
"Pagination": null
}
GET /branches
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID филиала |
name | string | Поиск по наименованию |
short_name | string | Поиск по краткому наименованию |
director | string | Поиск по ФИО директора |
bin | string | Поиск по БИН |
page | integer | Номер страницы (по умолчанию 1) |
limit | integer | Кол-во записей (по умолчанию 50) |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 1,
"name": "Филиал №1",
"short_name": "Ф1",
"director": "Иванов И. И.",
"bin": "123456789012"
}
],
"Pagination": {
"TotalCount": 1,
"Page": 1,
"Limit": 50,
"TotalPages": 1
}
}
GET /branches/{id}
Пример ответа (404 Not Found):
{
"IsSuccess": false,
"Error": "Данные по фильтру [1] не найдены или у вас нет прав на их просмотр.",
"Data": null,
"Pagination": null
}
GET /patients
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID пациента |
branch_id | integer | Фильтр по ID филиала |
fio | string | Поиск по ФИО |
phone | string | Поиск по телефону |
iin | string | Поиск по ИИН |
last_update_time | string | Фильтр по времени обновления (>=) |
cursor | string | Курсор пагинации |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 123,
"branch_id": 1,
"fio": "Иванов Иван Иванович",
"is_teen": 0,
"description": null,
"dob": "1990-05-15",
"sex": 1,
"phone": "+7 777 123 45 67",
"iin": "900515300123",
"resident": 1,
"passport": null,
"address": null,
"flat_num": null,
"createdate": 1736899200,
"pac_city": null,
"online_access": 1,
"send_notice": 1,
"reg_from": 0,
"last_update_time": "2026-10-16 12:34:56"
}
],
"Pagination": {
"Limit": 50,
"TotalCount": 1,
"NextCursor": null,
"HasMore": false
}
}
Создаёт нового пациента или возвращает существующего, если пациент с таким ИИН уже есть у подписчика. Все обязательные поля проверяются на сервере.
POST /patients
Тело запроса — application/json (или application/x-www-form-urlencoded).
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
branch_id |
integer | Да | ID филиала. Должен быть в списке доступных филиалов подписчика. |
source |
integer | Да | ID источника пациента. Должен быть доступен подписчику (см. /patientsources). |
country_id |
integer | Да | ID страны (см. /countries). Используется для проверки телефона и префикса. |
cl_name |
string | Да | ФИО. До 200 символов. Приводится к Title Case. |
cl_dob |
string | Да | Дата рождения в формате dd.mm.YYYY. |
cl_sex |
string | Да | Пол: 0 или 1. |
cl_phone |
string | Да | Телефон — только цифры, полный номер с префиксом (например 77771234567). |
cl_resident |
integer | Да | 1 — резидент РК, 0 — нерезидент. |
cl_iin |
string | Да, если cl_resident = 1 |
ИИН — 12 цифр. |
cl_passport |
string | Да, если cl_resident = 0 |
Паспорт. |
rec_address |
string | Нет | Адрес. |
rec_client_flat |
string | Нет | Квартира. |
Пример запроса:
POST /api/patients
Authorization: <ваш токен>
Content-Type: application/json
{
"branch_id": 4,
"source": 1,
"country_id": 1,
"cl_name": "Иванов Иван Иванович",
"cl_dob": "15.05.1990",
"cl_sex": "1",
"cl_phone": "77771234567",
"cl_resident": 1,
"cl_iin": "900515300123",
"rec_address": "г. Алматы, ул. Абая, 1",
"rec_client_flat": "12"
}
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": { "id": 12345 },
"Pagination": null
}
Пример ответа (ошибка валидации):
{
"IsSuccess": false,
"Error": "ИИН должен содержать 12 цифр; Неверная длина номера для страны [1] с префиксом [7]: ожидается 10 цифр после префикса, передано 9.",
"Data": null,
"Pagination": null
}
Пример ответа (недоступный источник):
{
"IsSuccess": false,
"Error": "Источник с ID [999] недоступен для вашего подписчика.",
"Data": null,
"Pagination": null
}
Пример ответа (нет прав на филиал):
{
"IsSuccess": false,
"Error": "Нет прав на создание пациента в этом филиале.",
"Data": null,
"Pagination": null
}
Пример ответа (страна не найдена):
{
"IsSuccess": false,
"Error": "Страна с ID [999] не найдена.",
"Data": null,
"Pagination": null
}
branch_id — обязателен, должен быть в списке доступных филиалов подписчика.source — обязателен, должен быть в patientsources для подписчика.country_id — обязателен, должен существовать в /countries.cl_name — обязателен, до 200 символов, Title Case.cl_dob — обязателен, dd.mm.YYYY, конвертируется в YYYY-MM-DD для БД.cl_sex — обязателен, 0 или 1.cl_phone — обязателен, только цифры, полный номер с префиксом. Проверяется по country_phone_mask страны.cl_resident = 1 → cl_iin обязателен, 12 цифр.cl_resident = 0 → cl_passport обязателен.
Дубли по ИИН: если пациент с таким ИИН уже есть у подписчика — возвращается его id (без создания нового).
Телефон проверяется по префиксу и маске страны из /countries.
GET /patientsources
Не привязан к филиалам. Доступные параметры: id, name, page, limit.
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 5,
"name": "Инстаграм"
}
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /services
| Параметр | Тип | Описание |
|---|---|---|
id | integer | ID услуги |
cat_id | integer | ID категории услуги |
branch_id | integer | ID филиала |
name | string | Название услуги (частичное совпадение) |
status | integer | Статус услуги (1/0) |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 101,
"branch_id": 1,
"cat_id": 3,
"is_set": 0,
"name": "Консультация терапевта",
"is_action": 0,
"cost": "5000",
"solary_cost": "1500",
"duration": 30,
"isonline": 1,
"onlinename": "Консультация терапевта (онлайн)",
"description": "Первичная консультация",
"iflimittime": 0,
"period_from": 0,
"period_to": 0,
"daysaccess": 0,
"time_aval_from": 0,
"time_aval_to": 0,
"show_onsite": 1,
"show_mydoc": 1,
"use_in_analitycs": 1,
"agree_id": 0,
"send_notice": 1,
"status": 1
}
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /servicecategories
Доступные параметры: id, branch_id, name, page, limit.
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{ "id": 3, "branch_id": 1, "name": "Терапия" }
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /patient-seeing
Возвращает список осмотров с деталями (вложенный массив details).
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID осмотра |
patient_id | integer | Фильтр по ID пациента |
user_id | integer | Фильтр по ID врача |
branch_id | integer | Фильтр по ID филиала |
status | integer | Фильтр по статусу |
create_date | string | Фильтр по дате создания (>=) |
last_update_time | string | Фильтр по времени обновления (>=) |
cursor | string | Курсор пагинации |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 55,
"patient_id": 123,
"user_id": 7,
"create_date": 1736899200,
"status": 1,
"token": "abc123",
"branch_id": 1,
"last_update_time": "2026-10-16 12:34:56",
"details": [
{
"detail_id": 10,
"group_num": 1,
"group_name": "Общий осмотр",
"data": "..."
}
]
}
],
"Pagination": { "Limit": 50, "TotalCount": 1, "NextCursor": null, "HasMore": false }
}
GET /journal
Возвращает список приёмов с деталями. Курсорная пагинация по last_update_time | id.
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID записи |
patient_id | integer | Фильтр по ID пациента |
branch_id | integer | Фильтр по ID филиала |
master_id | integer | Фильтр по ID мастера |
status | integer | Фильтр по статусу (ожидание-1|пришел-2|не пришел-3|подтвердил-4|есть предоплата-5) |
rec_status | integer | Фильтр: 1 - активная, 0 - удалена |
day | string | Фильтр по дню (timestamp или YYYY-MM-DD) |
reg_from | integer | Фильтр по IDисточнику пациента |
dateadd | string | Фильтр по дате добавления |
last_update_time | string | Фильтр по времени обновления (>=) Обновление поля при изменени: Пациента, Дня записи, Времени записи,Врача, Законного представителя, Статуса, Параметра уведомления СМС, Источника записи, Комментария, при Удалении записи |
cursor | string | Курсор пагинации |
Описание раздела [details]
| Параметр | Тип | Описание |
|---|---|---|
detail_id | integer | ID детали |
service_id | integer | ID услуги |
cost | float | Стоимость с учетом скидки |
serv_cost | float | Фиксированная стоимость услуги |
sal_value | float | Сумма вычета (используется для расчета ЗП сотрудника) |
duration | int | Длительность услуги в секундах |
detail_status | int | Статус 1 - активная, 0 - удалена |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 55,
"patient_id": 123,
"dateadd": 1736899200,
"day": 1736899200,
"timefrom": 1736900000,
"timeto": 1736901800,
"send_notice": 1,
"comment": "Первичный приём",
"master_id": 7,
"status": 1,
"rec_status": 1,
"token": "abc123",
"branch_id": 1,
"reg_from ": 2,
"last_update_time": "2026-10-16 12:34:56",
"details": [
{
"detail_id": 10,
"service_id": 101,
"cost": 5000,
"serv_cost": 1500,
"sal_value": 500,
"duration": 30,
"detail_status": 1
}
]
}
],
"Pagination": { "Limit": 50, "TotalCount": 1, "NextCursor": null, "HasMore": false }
}
GET /journaldatalog
Курсорная пагинация по id.
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID записи |
branch_id | integer | Фильтр по ID филиала |
jr_id | integer | Фильтр по ID записи журнала |
author_id | integer | Фильтр по ID автора |
operation_type | integer | Тип операции: 14 - Создание, 15 - Изменение, 16 - Удаление |
operation_date | integer | Дата операции (timestamp) |
operation_date_from | integer | Дата операции от (>=) |
operation_date_to | integer | Дата операции до (<=) |
id_from | integer | Фильтр «начиная с ID» (>=) |
cursor | string | Курсор пагинации |
Описание раздела [data]
| Параметр | Тип | Описание |
|---|---|---|
v1 | integer | ID пациента |
v2 | integer | День записи в формате unix-timestamp |
v3 | integer | Время начала записи в секундах от начала суток |
v4 | integer | Время завершения записи в секундах от начала суток |
v5 | integer | Общая продолжительность приема в секундах |
v6 | string | Комментарий |
v7 | string | Код цвета ячейки |
v8 | int | ID врача |
v9 | int | Статус |
v10 | int | Отправка СМС |
v11 | string | Законный представитель |
v12 | int | Источник пациента |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 1000,
"jr_id": 55,
"author_id": 7,
"operation_type": 15,
"operation_date": 1736899200,
"branch_id": 1,
"data":[
{
"v1":149008,
"v2":1790708400,
"v3":52200,
"v4":54000,
"v5":1800,
"v6":"",
"v7":"ffffff",
"v8":123,
"v9":1,
"v10":1,
"v11":"",
"v12":1
}
]
}
],
"Pagination": { "Limit": 50, "TotalCount": 1, "NextCursor": null, "HasMore": false }
}
GET /journalpayments
Курсорная пагинация по last_update_time | id.
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID платежа |
branch_id | integer | Фильтр по ID филиала |
parent_id | integer | ID родительской записи используется для перемещений и возвратов |
operation_type | string | Тип операции (income, expense, refund) |
record_id | integer | ID записи журнала |
stock_movement_id | integer | ID движения товара |
is_product | integer | 0 — услуга, 1 — продукт |
shift_id | integer | ID кассовой смены |
cash_id | integer | ID кассы (тип платежа опледеляется настройкой Кассы) |
master_id | integer | ID мастера |
client_id | integer | ID клиента |
user_id | integer | ID автора |
cbitem_type | string | Статья платежей (определяется справочником /cashbox-items) |
status | integer | 0 — удалена, 1 — нормальная |
date | string | День привязки записи |
date_from | string | День привязки от (>=) |
date_to | string | День привязки до (<=) |
comment | string | Поиск по комментарию |
check_id | integer | Поиск по ID чека. (наличие при успешной пробивке фискального чека) |
last_update_time | string | Фильтр по времени обновления (>=) |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 501,
"parent_id": 0,
"operation_type": "income",
"record_id": 55,
"stock_movement_id": 0,
"is_product": 0,
"shift_id": 12,
"cash_id": 3,
"master_id": 7,
"client_id": 123,
"user_id": 7,
"cbitem_type": "6",
"money": "5000.00",
"comment": null,
"status": 1,
"date": 1736899200,
"date_added": 1736899300,
"branch_id": 1,
"check_id" : 777,
"last_update_time": "2026-10-16 12:34:56"
}
],
"Pagination": { "Limit": 50, "TotalCount": 1, "NextCursor": null, "HasMore": false }
}
GET /cashboxes
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID кассы |
branch_id | integer | Фильтр по ID филиала |
cashtype | integer | Фильтр по типу кассы. 0 - Наличный, 1 - Безналичный |
name | string | Поиск по наименованию |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{ "id": 3, "branch_id": 1, "name": "Основная касса", "comment": "Приём наличных", "cashtype":1 }
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /cashboxitems
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID статьи |
branch_id | integer | Фильтр по ID филиала |
type | integer | 0 — расход, 1 — доход |
name | string | Поиск по наименованию |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{ "id": 10, "branch_id": 1, "name": "Оплата услуг", "comment": "Основная статья", "type": 1 }
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /cashshifts
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID смены |
cash_id | integer | Фильтр по ID кассы |
open_user_id | integer | Фильтр по автору открытия |
closed_by | integer | Фильтр по автору закрытия |
status | string | Статус смены (open, closed) |
branch_id | integer | Фильтр по ID филиала |
shift_start_from | string | Дата открытия от (>=) |
shift_start_to | string | Дата открытия до (<=) |
created_from | string | Дата создания от (>=) |
created_to | string | Дата создания до (<=) |
notes | string | Поиск по комментарию |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 12, "cash_id": 3, "open_user_id": 7, "shift_start": 1736899200,
"shift_end": 1736985600, "initial_amount": "0.00", "final_amount": "125000.00",
"calculated_amount": "125000.00", "difference": "0.00", "status": "closed",
"notes": "Смена закрыта без расхождений", "closed_by": 7,
"created_at": 1736899200, "branch_id": 1
}
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /worktime
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID записи |
branch_id | integer | Фильтр по ID филиала |
user_id | integer | Фильтр по ID пользователя |
doc_id | integer | Фильтр по ID документа/врача |
is_staff | integer | 0 — не штат, 1 — штат |
day | string | День (timestamp) |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 500, "branch_id": 1, "day": 1736899200, "doc_id": 7,
"time_from": 1736900000, "time_to": 1736936000,
"user_id": 7, "date_added": 1736899200, "is_staff": 1
}
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /users
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID пользователя |
branch_id | integer | Фильтр по ID филиала |
username | string | Поиск по логину |
fullname | string | Поиск по ФИО |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{ "id": 7, "fullname": "Иванов Иван Иванович", "username": "ivanov" }
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /positions
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID должности |
branch_id | integer | Фильтр по ID филиала |
name | string | Поиск по наименованию |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{ "id": 5, "name": "Врач-терапевт", "description": "Врач общей практики", "branch_id": 1 }
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /userpositions
| Параметр | Тип | Описание |
|---|---|---|
id | integer | Фильтр по ID записи |
user_id | integer | Фильтр по ID пользователя |
pos_id | integer | Фильтр по ID должности |
branch_id | integer | Фильтр по ID филиала |
page | integer | Номер страницы |
limit | integer | Кол-во записей |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{ "id": 100, "user_id": 7, "pos_id": "5", "branch_id": 1 }
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /paymentchecks
Возвращает список фискальных чеков, привязанных к оплате, с фильтрацией и офсетной пагинацией.
| Параметр | Тип | Описание |
|---|---|---|
id |
integer | Фильтр по ID чека |
branch_id |
integer | Фильтр по ID филиала |
patient_id |
integer | Фильтр по ID пациента |
author_id |
integer | Фильтр по ID автора (сотрудника, создавшего чек) |
parent_id |
integer | Фильтр по ID родительского чека (для возвратов) |
number |
string | Фильтр по номеру чека (точное совпадение) |
type |
integer | Тип чека (2 — приход, 3 — возврат прихода и т.п. согласно настройкам ОФД) |
mode |
integer | Режим налогообложения / режим чека |
status |
integer | Статус чека (0 — удалён, 1 — активен) |
page |
integer | Номер страницы. От 1 до 1000. По умолчанию 1. |
limit |
integer | Количество записей на странице. От 1 до 100. По умолчанию 50. |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 123,
"parent_id": 0,
"number": "312000000",
"patient_id": 456,
"author_id": 5,
"money": 5000,
"type": 2,
"mode": 0,
"token": "5f83d...c17520b18...",
"time": 1792510621,
"url": "http://consumer.oofd.kz?i=312720...",
"status": 1,
"branch_id": 6
}
],
"Pagination": {
"TotalCount": 1,
"Page": 1,
"Limit": 50,
"TotalPages": 1
}
}
GET /countries
Возвращает справочник стран. Не привязан к филиалам подписчика — доступен всем авторизованным клиентам.
| Параметр | Тип | Описание |
|---|---|---|
id |
integer | Фильтр по ID страны (точное совпадение) |
name |
string | Поиск по наименованию (подстрока) |
code |
string | Фильтр по коду страны (точное совпадение, например KZ) |
prefix |
string | Фильтр по телефонному префиксу (точное совпадение, например 7) |
page |
integer | Номер страницы. От 1 до 1000. По умолчанию 1. |
limit |
integer | Количество записей на странице. От 1 до 100. По умолчанию 50. |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 1,
"flag": "🇰🇿",
"name": "Казахстан",
"prefix": "7",
"code": "KZ",
"mask": "999 999 9999"
}
],
"Pagination": {
"TotalCount": 1,
"Page": 1,
"Limit": 50,
"TotalPages": 1
}
}
| Поле | Тип | Описание |
|---|---|---|
id |
integer | ID страны |
flag |
string | Флаг страны (эмодзи) |
name |
string | Наименование страны |
prefix |
string | Телефонный префикс страны (например 7 для Казахстана) |
code |
string | Двухбуквенный код страны (ISO 3166-1 alpha-2, например KZ) |
mask |
string | Маска телефонного номера без префикса. Цифра 9 обозначает обязательную цифру (например 999 999 9999 — 10 цифр после префикса) |
Возвращает список услуг, на которые можно записаться в выбранном филиале: только онлайн-услуги, у которых есть свободные окна у доступных мастеров и которые не ограничены по времени недоступным периодом.
GET /bookingservices
| Параметр | Тип | Описание |
|---|---|---|
branch_id |
integer | ID филиала. Обязателен. |
service_ids |
string | CSV ID услуг (например 3517,3687). Если передан — возвращаются только эти услуги. |
staff_id |
integer | ID мастера. Если передан — возвращаются только услуги, которые оказывает этот мастер. |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": {
"categories": [
{ "id": 22, "name": "УЗИ для взрослых", "branch_id": 1 }
],
"services": [
{
"id": 3645,
"cat_id": 22,
"branch_id": 1,
"name": "УЗИ взрослое",
"cost": 6500,
"minCost": 5000,
"maxCost": 6500,
"duration": 900,
"isonline": 1,
"status": 1,
"slots_count": 39,
"max_window": 43200,
"first_date": "2026-10-27"
}
]
},
"Pagination": null
}
Если у услуги есть персональные цены у разных мастеров,
minCost / maxCost показывают диапазон (например, 5000 – 6500).
Если цены одинаковые или персональных нет — оба поля равны базовой cost.
| Поле | Тип | Описание |
|---|---|---|
categories[] | array | Категории, к которым относятся доступные услуги |
categories[].id | integer | ID категории |
categories[].name | string | Наименование категории |
categories[].branch_id | integer | ID филиала |
services[] | array | Доступные услуги |
services[].id | integer | ID услуги |
services[].cat_id | integer | ID категории |
services[].branch_id | integer | ID филиала |
services[].name | string | Наименование услуги |
services[].cost | float | Базовая стоимость услуги (jss_cost) |
services[].minCost | float | Минимальная цена (из персональных цен мастеров; если персональных нет — равна cost) |
services[].maxCost | float | Максимальная цена (из персональных цен мастеров; если персональных нет — равна cost) |
services[].duration | integer | Длительность услуги в секундах |
services[].isonline | integer | 1 — доступна онлайн |
services[].status | integer | 1 — активна |
services[].slots_count | integer | Общее количество свободных окон |
services[].max_window | integer | Максимальная длительность свободного окна (секунды). Если окно короче duration — услуга не попадает в ответ. |
services[].first_date | string | Первый доступный день (YYYY-MM-DD) |
Возвращает список мастеров, доступных для онлайн-записи в выбранном филиале: только те, у кого есть свободные окна, кто не скрыт в онлайн-записи (Настройка доступа) и кто привязан к подписчику.
GET /bookingstaff
| Параметр | Тип | Описание |
|---|---|---|
branch_id |
integer | ID филиала. Обязателен. |
service_ids |
string | CSV ID услуг (например 3517,3687). Если передан — возвращаются только мастера, оказывающие эти услуги. |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 222,
"fullname": "Иванов Иван Иванович",
"position": "Врач-терапевт",
"photo": "https://path...",
"reviews_count": 12,
"rating": 5,
"duration": 1200,
"cost": 5000,
"sort": "1"
}
],
"Pagination": null
}
| Поле | Тип | Описание |
|---|---|---|
id | integer | ID мастера |
fullname | string | ФИО |
position | string | Должность (одна или несколько через - ) |
photo | string|null | URL фото |
reviews_count | integer | Количество отзывов |
rating | integer|null | Рейтинг (1–5), null — нет отзывов |
duration | integer|null | Длительность услуги у мастера (секунды), null — услуга не передана |
cost | float|null | Стоимость услуги у мастера, null — услуга не передана |
sort | string|null | Значение сортировки |
Сортировка: сначала мастера с заданной сортировкой (по возрастанию sort), затем — без сортировки (по ФИО).
Возвращает свободные слоты только за выбранный день (или за первый доступный, если datetime не передан) + список всех доступных дней. Если дня нет в свободных окнах — 200 OK с пустым slots[].
GET /bookingavailability
| Параметр | Тип | Описание |
|---|---|---|
branch_id |
integer | ID филиала. Обязателен. |
service_ids |
string | CSV ID услуг. Обязателен. |
staff_id |
integer | ID мастера. Обязателен. |
datetime |
string | День в формате YYYY-MM-DD. Опционален: если не передан — берётся первый доступный день. |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": {
"date": "2026-10-27",
"date_ts": 1793214000,
"master_id": 222,
"service_ids": [3517],
"min_duration": 1200,
"slots": [
{ "from": 30600, "to": 39600, "from_time": "08:30", "to_time": "11:00" },
{ "from": 50100, "to": 52200, "from_time": "13:55", "to_time": "14:30" }
],
"available_dates": ["2026-10-27", "2026-10-28", "2026-10-29"]
},
"Pagination": null
}
Пример ответа (день без слотов):
{
"IsSuccess": true,
"Error": null,
"Data": {
"date": "2026-12-31",
"date_ts": 1798664400,
"master_id": 222,
"service_ids": [3517],
"min_duration": 1200,
"slots": [],
"available_dates": ["2026-10-27", "2026-10-28"]
},
"Pagination": null
}
Пример ответа (неверный формат datetime):
{
"IsSuccess": false,
"Error": "datetime должен быть в формате YYYY-MM-DD.",
"Data": null,
"Pagination": null
}
| Поле | Тип | Описание |
|---|---|---|
date | string|null | Выбранный день (YYYY-MM-DD), null — нет доступных дней |
date_ts | integer|null | Unix timestamp начала дня |
master_id | integer | ID мастера |
service_ids | integer[] | ID услуг |
min_duration | integer|null | Минимальная длительность услуги у мастера (секунды) |
slots[] | array | Свободные окна на выбранный день |
slots[].from | integer | Начало окна — секунды от начала суток |
slots[].to | integer | Конец окна — секунды от начала суток |
slots[].from_time | string | Начало окна в формате H:i |
slots[].to_time | string | Конец окна в формате H:i |
available_dates[] | string[] | Все доступные дни (YYYY-MM-DD) |
Ограничения: service_ids и staff_id обязательны; datetime должен быть в формате YYYY-MM-DD (иначе IsSuccess: false).
Создаёт запись на приём. Поддерживает два сценария:
cl_id, данные пациента не требуются (проверяется принадлежность подписчику).POST /appointments
Тело запроса — application/json (или application/x-www-form-urlencoded).
| Поле | Тип | Описание |
|---|---|---|
branch_id | integer | ID филиала. Должен быть в списке доступных филиалов подписчика. |
master_id | integer | ID мастера. Должен оказывать выбранные услуги. |
service_ids | string | CSV ID услуг (например 3517,3687). |
day | string | День записи в формате YYYY-MM-DD. |
time_from | string | Время начала в формате HH:MM. |
country_id | integer | ID страны (см. /countries). Используется для валидации телефона. |
source | integer | ID источника пациента (см. /patientsources). |
cl_id)| Поле | Тип | Описание |
|---|---|---|
cl_id | integer | ID пациента. Проверяется по группе филиалов (без branch_id). |
Если cl_id передан — поля cl_* не требуются и не проверяются. Пациент должен принадлежать подписчику и иметь mp_online_access = 1.
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
cl_name | string | Да | ФИО (до 200 символов, Title Case). |
cl_dob | string | Да | Дата рождения в формате dd.mm.YYYY. |
cl_sex | string | Да | Пол: 0 или 1. |
cl_phone | string | Да | Телефон — только цифры, полный номер с префиксом (например 77771234567). |
cl_resident | integer | Да | 1 — резидент РК, 0 — нерезидент. |
cl_iin | string | Да, если cl_resident = 1 | ИИН — 12 цифр. |
cl_passport | string | Да, если cl_resident = 0 | Паспорт. |
rec_address | string | Нет | Адрес. |
rec_client_flat | string | Нет | Квартира. |
cl_need_update | integer | Нет | 1 (по умолчанию) — обновить данные найденного пациента, 0 — не обновлять. ИИН не перезаписывается, если уже занят другим пациентом подписчика. |
Пример запроса (сценарий B — новый пациент):
POST /api/appointments
Authorization: <ваш токен>
Content-Type: application/json
{
"branch_id": 1,
"master_id": 222,
"service_ids": "10",
"day": "2026-10-28",
"time_from": "14:00",
"country_id": 1,
"source": 21,
"cl_name": "Иванов Петр Иванович",
"cl_dob": "10.01.1980",
"cl_sex": "1",
"cl_phone": "77771234578",
"cl_resident": 1,
"cl_iin": "800110300456"
}
Пример запроса (сценарий A — известный пациент):
POST /api/appointments
Authorization: <ваш токен>
Content-Type: application/json
{
"branch_id": 4,
"master_id": 222,
"service_ids": "10",
"day": "2026-10-28",
"time_from": "14:30",
"country_id": 1,
"source": 21,
"cl_id": 21777
}
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": {
"id": 26,
"token": "ntTKHFSLqGtTlkw9-YjGz5...yYib",
"day": "2026-10-28",
"time_from": "12:00",
"time_to": "12:05",
"master_id": 243,
"patient_id": 21674,
"is_new_patient": false,
"total_cost": 2500,
"duration": 300
},
"Pagination": null
}
Пример ответа (время занято):
{
"IsSuccess": false,
"Error": "Выбранное время уже занято. Выберите другое.",
"Data": null,
"Pagination": null
}
Пример ответа (нет подходящего окна):
{
"IsSuccess": false,
"Error": "Выбранное время недоступно (нет подходящего окна).",
"Data": null,
"Pagination": null
}
Пример ответа (мастер не оказывает услугу):
{
"IsSuccess": false,
"Error": "Одна или несколько услуг недоступны для выбранного мастера/филиала.",
"Data": null,
"Pagination": null
}
Пример ответа (пациент в чёрном списке):
{
"IsSuccess": false,
"Error": "Пациент в чёрном списке.",
"Data": null,
"Pagination": null
}
Пример ответа (нет доступа к онлайн-записи):
{
"IsSuccess": false,
"Error": "У пациента нет доступа к онлайн-записи. Обратитесь к администратору.",
"Data": null,
"Pagination": null
}
Пример ответа (пациент не найден по cl_id):
{
"IsSuccess": false,
"Error": "Пациент с ID [99999] не найден или нет прав на его просмотр.",
"Data": null,
"Pagination": null
}
| Поле | Тип | Описание |
|---|---|---|
id | integer | ID созданной записи в журнале |
token | string | Токен записи |
day | string | День записи (YYYY-MM-DD) |
time_from | string | Время начала (HH:MM) |
time_to | string | Время окончания (HH:MM) |
master_id | integer | ID мастера |
patient_id | integer | ID пациента |
is_new_patient | boolean | true — пациент создан, false — найден существующий |
total_cost | integer | Сумма по услугам (целые) |
duration | integer | Общая длительность услуг (секунды) |
/bookingavailability (TFJR). Время [time_from, time_from + duration] должно полностью попадать в свободное окно мастера.rec_status = 1) запрещены.GET_LOCK (3 сек). При занятости — IsSuccess: false.группы филиалов (только для сценария B).online_access = 0 у существующего пациента — запись не создаётся, возвращается ошибка.
Поля rec_type = 5 (API), comment = 'Api', reccolor = '#907b9f',
reg_from = source заполняются автоматически и клиенту передавать их не нужно.
Отменяет (soft delete) запись на приём. Запись не удаляется физически — устанавливается js_rec_status = 0. Слот освобождается для новых записей. Можно указать причину отмены (calling_res) и комментарий (comment).
DELETE /appointments/{id}
ID записи передаётся в URL. Дополнительные параметры (branch_id, calling_res, comment) — в query-строке. Тело запроса не используется.
| Параметр | Где | Тип | Обязательно | Описание |
|---|---|---|---|---|
id |
path | integer | Да | ID записи |
branch_id |
query | integer | Нет | ID филиала. Если передан — должен быть в списке доступных филиалов подписчика. |
calling_res |
query | integer | Нет | Причина отмены (код). Сохраняется в calling_res. |
comment |
query | string | Нет | Комментарий к отмене (до 255 символов). Сохраняется в comment. |
Пример запроса (с причиной и комментарием):
DELETE /api/appointments/266736?branch_id=1&calling_res=3&comment=Пациент%20не%20может%20прийти
Authorization: <ваш токен>
Пример запроса (минимальный):
DELETE /api/appointments/266736
Authorization: <ваш токен>
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": {
"id": 266736,
"status": 0,
"calling_res": 3,
"comment": "Пациент не может прийти",
"cancelled_at": "2026-10-27 18:33:13"
},
"Pagination": null
}
Пример ответа (повторная отмена, идемпотентно):
{
"IsSuccess": true,
"Error": null,
"Data": {
"id": 266736,
"status": 0,
"calling_res": 3,
"comment": "Пациент не может прийти",
"cancelled_at": "2026-10-27 18:33:13"
},
"Pagination": null
}
При повторной отмене возвращается cancelled_at первой отмены (из last_update_time). Причина и комментарий при повторной отмене не перезаписываются — возвращаются значения, сохранённые при первой отмене.
Пример ответа (запись не найдена / чужой подписчик):
{
"IsSuccess": false,
"Error": "Запись с ID [999999] не найдена или нет прав на её отмену.",
"Data": null,
"Pagination": null
}
Пример ответа (нет прав на филиал):
{
"IsSuccess": false,
"Error": "Нет прав на отмену записи в этом филиале.",
"Data": null,
"Pagination": null
}
Пример ответа (нет id в URL):
{
"IsSuccess": false,
"Error": "Параметр id обязателен (DELETE /appointments/{id}).",
"Data": null,
"Pagination": null
}
Пример ответа (слишком длинный calling_res):
{
"IsSuccess": false,
"Error": "calling_res: не более 255 символов.",
"Data": null,
"Pagination": null
}
Пример ответа (слишком длинный comment):
{
"IsSuccess": false,
"Error": "comment: не более 255 символов.",
"Data": null,
"Pagination": null
}
| Поле | Тип | Описание |
|---|---|---|
id | integer | ID отменённой записи |
status | integer | Всегда 0 — запись отменена |
calling_res | string|null | Причина отмены (до 255 символов). null, если не передавалась. |
comment | string|null | Комментарий (до 255 символов). null, если не передавался. |
cancelled_at | string | Дата-время отмены (YYYY-MM-DD HH:MM:SS, Asia/Almaty UTC+5). При повторной отмене — дата первой отмены. |
rec_status = 0. Слот освобождается для новых записей.DELETE на уже отменённую запись возвращает 200 IsSuccess: true (без ошибки), с той же датой отмены.calling_res (строка, до 255 символов). Если не передан — calling_res не изменяется.comment (строка, до 255 символов). Если не передан — comment не изменяется.DELETE calling_res и comment не перезаписываются.
Поля rec_status = 0, calling_res, comment, last_update_time обновляются автоматически.
Изменяет день, время, мастера и состав услуг существующей активной записи. Пациент (cl_id) и филиал (branch_id) не меняются — филиал записи проверяется на принадлежность подписчику.
Логика совпадает с МИС: пересчёт длительности и стоимости, проверка окна мастера (TFJR) и пересечений, сериализация через GET_LOCK, сдвиг уведомлений, актуализация услуг и запись в journalDataLog (operation_type = 15).
PATCH /appointments/{id}
Тело запроса — application/json (или application/x-www-form-urlencoded). id записи берётся из URL.
| Поле | Тип | Описание |
|---|---|---|
day | string | Новый день записи в формате YYYY-MM-DD. |
time_from | string | Новое время начала в формате HH:MM. |
master_id | integer | ID мастера. Должен оказывать выбранные услуги в филиале записи. |
service_ids | string | CSV ID услуг (например 3517,3687). Полный новый состав услуг записи. |
Пациент и филиал не передаются
Пример запроса:
PATCH /api/appointments/26
Authorization: <ваш токен>
Content-Type: application/json
{
"day": "2026-10-29",
"time_from": "15:00",
"master_id": 243,
"service_ids": "10"
}
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": {
"id": 26,
"day": "2026-10-29",
"time_from": "15:00",
"time_to": "15:05",
"master_id": 243,
"patient_id": 21674,
"duration": 300,
"total_cost": 2500,
"updated_at": "2026-10-28 12:34:56",
"old": {
"day": "2026-10-28",
"time_from": "12:00",
"master_id": 222
}
},
"Pagination": null
}
Пример ответа (запись отменена):
{
"IsSuccess": false,
"Error": "Запись отменена, перенос невозможен.",
"Data": null,
"Pagination": null
}
Пример ответа (нет подходящего окна):
{
"IsSuccess": false,
"Error": "Выбранное время недоступно (нет подходящего окна).",
"Data": null,
"Pagination": null
}
Пример ответа (время занято):
{
"IsSuccess": false,
"Error": "Выбранное время уже занято. Выберите другое.",
"Data": null,
"Pagination": null
}
Пример ответа (мастер не оказывает услугу):
{
"IsSuccess": false,
"Error": "Одна или несколько услуг недоступны для выбранного мастера/филиала.",
"Data": null,
"Pagination": null
}
Пример ответа (сервис занят, GET_LOCK):
{
"IsSuccess": false,
"Error": "Сервис занят, попробуйте позже.",
"Data": null,
"Pagination": null
}
Пример ответа (запись не найдена):
{
"IsSuccess": false,
"Error": "Запись с ID [26] не найдена или нет прав на её просмотр.",
"Data": null,
"Pagination": null
}
| Поле | Тип | Описание |
|---|---|---|
id | integer | ID записи в журнале |
day | string | Новый день записи (YYYY-MM-DD) |
time_from | string | Новое время начала (HH:MM) |
time_to | string | Новое время окончания (HH:MM) |
master_id | integer | ID мастера |
patient_id | integer | ID пациента |
duration | integer | Общая длительность услуг (секунды) |
total_cost | integer | Сумма по услугам (целые) |
updated_at | string | last_update_time записи после COMMIT |
old | object | Прежние значения: day, time_from, master_id |
rec_status = 0 возвращается ошибка «Запись отменена, перенос невозможен»./bookingavailability Время [time_from, time_from + duration] должно полностью попадать в свободное окно мастера.worktime).GET_LOCK('appointment_<master>_<day>', 3). При занятости — IsSuccess: false.Возвращает список отзывов клиентов о мастерах филиала.
GET /reviews
| Параметр | Тип | Описание |
|---|---|---|
id | integer | ID отзыва |
master_id | integer | ID мастера |
client_id | integer | ID клиента |
branch_id | integer | ID филиала |
stars | integer | Оценка (1–5) |
status | integer | 0 — скрыт, 1 — активен |
client_name | string | Поиск по имени клиента (подстрока) |
review | string | Поиск по тексту отзыва (подстрока) |
day_added | integer | День добавления (timestamp) |
date_added_from | string | Дата добавления от (>=) |
date_added_to | string | Дата добавления до (<=) |
page | integer | Номер страницы. От 1 до 1000. По умолчанию 1. |
limit | integer | Количество записей. От 1 до 100. По умолчанию 50. |
Пример успешного ответа (200 OK):
{
"IsSuccess": true,
"Error": null,
"Data": [
{
"id": 501,
"master_id": 222,
"day_added": 1793214000,
"date_added": "2026-10-27 14:30:00",
"client_id": 123,
"client_name": "Иванов Иван",
"review": "Отличный врач, всё объяснил",
"answer": null,
"stars": 5,
"status": 1,
"branch_id": 1
}
],
"Pagination": { "TotalCount": 1, "Page": 1, "Limit": 50, "TotalPages": 1 }
}
GET /reviews/{id}
Пример ответа (404 Not Found):
{
"IsSuccess": false,
"Error": "Отзыв с ID [999] не найден или у вас нет прав на его просмотр.",
"Data": null,
"Pagination": null
}
| Поле | Тип | Описание |
|---|---|---|
id | integer | ID отзыва |
master_id | integer | ID мастера |
day_added | integer | День добавления (unix timestamp) |
date_added | string | Дата-время добавления |
client_id | integer | ID клиента |
client_name | string | Имя клиента |
review | string | Текст отзыва |
answer | string|null | Ответ мастера/клиники |
stars | integer | Оценка (1–5) |
status | integer | 0 — скрыт, 1 — активен |
branch_id | integer | ID филиала |