SmartCommAI API (1.0.0)

Download OpenAPI specification:

API Support: support@example.com URL: https://example.com/support

Документация API SmartCommAI

authentication

Аутентификация

Вход

Вход по логину и паролю

Request Body schema: application/json
required

login required	string Логин пользователя
password required	string Пароль пользователя

Responses

Request samples

Payload

Content type

application/json

{"login": "admin",
"password": "Qwerty123"
}

Response samples

200
400
401
422
500

Content type

application/json

{"data": {"id": 12,
"country": {"id": 12,
"alias": "FRA",
"title": "France",
"phone": {"code": 33,
"codePreview": "+1-767",
"phoneStartsWith": "767",
"mask": "##-##-##-##",
"lengthMin": 11,
"lengthMax": 14,
"lengthDiff": 3
},
"flagUrl": "http://example.com/flag.jpg"
},
"language": {"id": 12,
"code": "en",
"name": "English"
},
"currency": {"id": 12,
"code": "USD",
"name": "United States dollar"
},
"created_at": "2025-09-21T12:00:00Z",
"login": "JohnDoe1987",
"name": "John",
"surname": "Doe",
"birthDate": "1987-05-19",
"phone": "+16842344567",
"email": "johndoe87@gmail.com"
}
}

Выход

Выход (закрытие сессии)

Responses

Response samples

401
500

Content type

application/problem+json

{"type": "https://api.example.com/problems/unauthorized",
"title": "Не авторизован",
"status": 401,
"detail": "Сессия не найдена или истекла.",
"instance": "/auth/me"
}

Регистрация

Регистрация пользователя

Request Body schema: application/json
required

login required	string Логин пользователя
name required	string Имя пользователя
surname required	string Фамилия пользователя
birthDate required	string <date> Дата рождения пользователя
phone required	string^\+[1-9]\d{1,14}$ Телефон пользователя
email required	string <email> E-mail пользователя
countryId required	integer Идентификатор страны пользователя
password required	string Пароль пользователя

Responses

Request samples

Payload

Content type

application/json

{"login": "JohnDoe1987",
"name": "John",
"surname": "Doe",
"birthDate": "1987-05-19",
"phone": "+16842344567",
"email": "johndoe87@gmail.com",
"countryId": 12,
"password": "Qwerty123"
}

Response samples

201
400
422
500

Content type

application/json

{"data": {"id": 12,
"country": {"id": 12,
"alias": "FRA",
"title": "France",
"phone": {"code": 33,
"codePreview": "+1-767",
"phoneStartsWith": "767",
"mask": "##-##-##-##",
"lengthMin": 11,
"lengthMax": 14,
"lengthDiff": 3
},
"flagUrl": "http://example.com/flag.jpg"
},
"language": {"id": 12,
"code": "en",
"name": "English"
},
"currency": {"id": 12,
"code": "USD",
"name": "United States dollar"
},
"created_at": "2025-09-21T12:00:00Z",
"login": "JohnDoe1987",
"name": "John",
"surname": "Doe",
"birthDate": "1987-05-19",
"phone": "+16842344567",
"email": "johndoe87@gmail.com"
}
}

profile

Профиль

Профиль пользователя

Возвращает профиль текущего пользователя

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"id": 12,
"country": {"id": 12,
"alias": "FRA",
"title": "France",
"phone": {"code": 33,
"codePreview": "+1-767",
"phoneStartsWith": "767",
"mask": "##-##-##-##",
"lengthMin": 11,
"lengthMax": 14,
"lengthDiff": 3
},
"flagUrl": "http://example.com/flag.jpg"
},
"language": {"id": 12,
"code": "en",
"name": "English"
},
"currency": {"id": 12,
"code": "USD",
"name": "United States dollar"
},
"created_at": "2025-09-21T12:00:00Z",
"login": "JohnDoe1987",
"name": "John",
"surname": "Doe",
"birthDate": "1987-05-19",
"phone": "+16842344567",
"email": "johndoe87@gmail.com"
}
}

Редактирование профиля пользователя

Редактирует и возвращает профиль текущего пользователя

Request Body schema: application/json
required

login	string Логин пользователя
name	string Имя пользователя
surname	string Фамилия пользователя
birthDate	string <date> Дата рождения пользователя
phone	string^\+[1-9]\d{1,14}$ Телефон пользователя
email	string <email> E-mail пользователя
countryId	integer Идентификатор страны пользователя
languageId	integer Идентификатор языка
currencyId	integer Идентификатор валюты

Responses

Request samples

Payload

Content type

application/json

{"login": "JohnDoe1987",
"name": "John",
"surname": "Doe",
"birthDate": "1987-05-19",
"phone": "+16842344567",
"email": "johndoe87@gmail.com",
"countryId": 12,
"languageId": 12,
"currencyId": 12
}

Response samples

200
400
401
422
500

Content type

application/json

{"data": {"id": 12,
"country": {"id": 12,
"alias": "FRA",
"title": "France",
"phone": {"code": 33,
"codePreview": "+1-767",
"phoneStartsWith": "767",
"mask": "##-##-##-##",
"lengthMin": 11,
"lengthMax": 14,
"lengthDiff": 3
},
"flagUrl": "http://example.com/flag.jpg"
},
"language": {"id": 12,
"code": "en",
"name": "English"
},
"currency": {"id": 12,
"code": "USD",
"name": "United States dollar"
},
"created_at": "2025-09-21T12:00:00Z",
"login": "JohnDoe1987",
"name": "John",
"surname": "Doe",
"birthDate": "1987-05-19",
"phone": "+16842344567",
"email": "johndoe87@gmail.com"
}
}

objects

Объекты

Список объектов

Возвращает список объектов пользователя

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
]
}

Создание объекта

Создаёт новый объект и возвращает его.

Request Body schema: application/json
required

Данные для создания объекта.

name	string Название объекта.
area	number <float> Площадь объекта (в квадратных метрах).
address	string Адрес объекта.

Responses

Request samples

Payload

Content type

application/json

{"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London"
}

Response samples

201
400
401
422
500

Content type

application/json

{"data": {"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
}

Один объект

Возвращает объект по идентификатору.

path Parameters

id

required

integer >= 1

Example: 123

Уникальный идентификатор сущности.

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
}

Редактирование объекта

Обновляет объект по идентификатору и возвращает его.

path Parameters

id

required

integer >= 1

Example: 123

Уникальный идентификатор сущности.

Request Body schema: application/json
required

Данные для обновления объекта.

name	string Название объекта.
area	number <float> Площадь объекта (в квадратных метрах).
address	string Адрес объекта.

Responses

Request samples

Payload

Content type

application/json

{"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London"
}

Response samples

Content type

application/json

{"data": {"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
}

Удаление объекта

Удаляет объект по идентификатору.

path Parameters

id

required

integer >= 1

Example: 123

Уникальный идентификатор сущности.

Responses

Response samples

401
404
500

Content type

application/problem+json

{"type": "https://api.example.com/problems/unauthorized",
"title": "Не авторизован",
"status": 401,
"detail": "Сессия не найдена или истекла.",
"instance": "/auth/me"
}

events

События

Список событий

Возвращает список событий с курсорной пагинацией.

query Parameters

limit	integer [ 1 .. 200 ] Default: 50 Example: limit=50 Количество элементов в результате
cursor	string Example: cursor=eyJuYW1lIjogItCf0YDQvtC00LDQstC10YYiLCAiaWQiOiAxMjMgfQ== Курсор пагинации
object_id	integer Example: object_id=101 Фильтр по объекту.
date_from	string <date> Example: date_from=2026-01-01 Начало периода (YYYY-MM-DD).
date_to	string <date> Example: date_to=2026-01-31 Конец периода (YYYY-MM-DD).

Responses

Response samples

200
401
500

Content type

application/json

{"pagination": {"nextCursor": "eyJuYW1lIjogItCf0YDQvtC00LDQstC10YYiLCAiaWQiOiAxMjMgfQ==",
"hasMore": true
},
"data": [{"notification_date": "2025-12-14",
"income": 12000,
"expense": 10000,
"description": "Оплатить до 20 числа",
"id": 501,
"created_at": "2026-01-15T08:00:00Z",
"updated_at": "2026-01-15T08:05:00Z",
"object": {"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
}
]
}

Добавление события

Создаёт новое событие и возвращает его.

Request Body schema: application/json
required

Данные для создания события.

notification_date required	string <date> Дата уведомления.
income required	integer Доход.
expense required	integer Расход.
description required	string Описание/заметки.
object_id required	integer Идентификатор объекта, к которому относится событие.

Responses

Request samples

Payload

Content type

application/json

{"notification_date": "2025-12-14",
"income": 12000,
"expense": 10000,
"description": "Оплатить до 20 числа",
"object_id": 0
}

Response samples

201
400
401
422
500

Content type

application/json

{"data": {"notification_date": "2025-12-14",
"income": 12000,
"expense": 10000,
"description": "Оплатить до 20 числа",
"id": 501,
"created_at": "2026-01-15T08:00:00Z",
"updated_at": "2026-01-15T08:05:00Z",
"object": {"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
}
}

Одно событие

Возвращает событие по идентификатору.

path Parameters

id

required

integer >= 1

Example: 123

Уникальный идентификатор сущности.

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"notification_date": "2025-12-14",
"income": 12000,
"expense": 10000,
"description": "Оплатить до 20 числа",
"id": 501,
"created_at": "2026-01-15T08:00:00Z",
"updated_at": "2026-01-15T08:05:00Z",
"object": {"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
}
}

Редактирование события

Обновляет событие по идентификатору и возвращает его.

path Parameters

id

required

integer >= 1

Example: 123

Уникальный идентификатор сущности.

Request Body schema: application/json
required

Данные для обновления события.

notification_date	string <date> Дата уведомления.
income	integer Доход.
expense	integer Расход.
description	string Описание/заметки.
object_id	integer Идентификатор объекта, к которому относится событие.

Responses

Request samples

Payload

Content type

application/json

{"notification_date": "2025-12-14",
"income": 12000,
"expense": 10000,
"description": "Оплатить до 20 числа",
"object_id": 0
}

Response samples

Content type

application/json

{"data": {"notification_date": "2025-12-14",
"income": 12000,
"expense": 10000,
"description": "Оплатить до 20 числа",
"id": 501,
"created_at": "2026-01-15T08:00:00Z",
"updated_at": "2026-01-15T08:05:00Z",
"object": {"id": 101,
"name": "Studio Nook",
"area": 28.5,
"address": "12 Mercury Lane, Soho, London",
"created_at": "2026-01-12T09:00:00Z",
"updated_at": "2026-01-15T09:10:00Z"
}
}
}

Удаление события

Удаляет событие по идентификатору.

path Parameters

id

required

integer >= 1

Example: 123

Уникальный идентификатор сущности.

Responses

Response samples

401
404
500

Content type

application/problem+json

{"type": "https://api.example.com/problems/unauthorized",
"title": "Не авторизован",
"status": 401,
"detail": "Сессия не найдена или истекла.",
"instance": "/auth/me"
}

dictionaries

Справочники

Страны и телефоны

Возвращает список стран и формат телефонных номеров

Responses

Response samples

200
500

Content type

application/json

{"data": [{"id": 12,
"alias": "FRA",
"title": "France",
"phone": {"code": 33,
"codePreview": "+1-767",
"phoneStartsWith": "767",
"mask": "##-##-##-##",
"lengthMin": 11,
"lengthMax": 14,
"lengthDiff": 3
},
"flagUrl": "http://example.com/flag.jpg"
}
]
}

Валюты

Возвращает список валют

Responses

Response samples

200
500

Content type

application/json

{"data": [{"id": 12,
"code": "USD",
"name": "United States dollar"
}
]
}

Языки

Возвращает список языков

Responses

Response samples

200
500

Content type

application/json

{"data": [{"id": 12,
"code": "en",
"name": "English"
}
]
}

SmartCommAI API (1.0.0)

authentication

Вход

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Выход

Responses

Response samples

Регистрация

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

profile

Профиль пользователя

Responses

Response samples

Редактирование профиля пользователя

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

objects

Список объектов

Responses

Response samples

Создание объекта

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Один объект

path Parameters

Responses

Response samples

Редактирование объекта

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Удаление объекта

path Parameters

Responses

Response samples

events

Список событий

query Parameters

Responses

Response samples

Добавление события

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Одно событие

path Parameters

Responses

Response samples

Редактирование события

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Удаление события

path Parameters

Responses

Response samples

dictionaries

Страны и телефоны

Responses

Response samples

Валюты

Responses

Response samples

Языки

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required