Перейти к основному содержимому
API docs by Redocly

Evolutrix CRM Rest API | Core (1.0.0)

Download OpenAPI specification:Download

Описание Rest API | Core — методов для взаимодействия с серверной стороной ядра проекта.

Коллекция Postman со всеми методами.

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

В данном разделе описаны Rest API методы для аутентификации сотрудника в системе. Для аутентификации используется Laravel Sanctum. В web версии системы аутентификация осуществляется через cookie файлы, в то время как для Rest API механизм использует bearer — токен.

Методы login и logout для web версии доступны по адресам /web/auth/login и /web/auth/logout соответственно. Request и response для них идентичны тем, что описаны в этом разделе для Rest API, за исключением того, что метод login в случае успешной аутентификации не возвращает bearer — токен, а устанавливает cookie.

Метод verify 2FA для web версии доступен по адресу /web/auth/verify-2fa. Request и response для него идентичны тем, что описаны в этом разделе для Rest API, за исключением того, что метод в случае успешной аутентификации не возвращает bearer — токен, а устанавливает cookie.

Механизм аутентификации клиентской стороны в web версии описан в документации Laravel Sanctum.

login

Аутентификация пользователя.

Если у пользователя отключена двухфакторная аутентификация - в случае успеха вернётся ответ с кодом 200, после чего пользователь будет считаться аутентифицированным.

Если у пользователя включена двухфакторная аутентификация - в случае успеха вернётся ответ с кодом 202, для окончательной аутентификации пользователя потребуется подтвердить аутентификацию с помощью кода из email письма через метод verify 2FA.

Request Body schema: application/json
required

Данные сотрудника для аутентификации

email
required
string

Email сотрудника

password
required
string

Пароль сотрудника

remember
boolean

Флаг "Запомнить меня"

recaptcha_token
required

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com",
  • "password": "password",
  • "remember": true,
  • "recaptcha_token": "recaptcha_token"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

verify 2FA

Подтверждение двухфакторной аутентификации пользователя.

Request Body schema: application/json
required

Данные для двухфакторной аутентификации

two_factor_challenge_uuid
required
string

Идентификатор проверки двухфакторной аутентификации из метода login

code
required
string

Проверочный код двухфакторной аутентификации

Responses

Request samples

Content type
application/json
{
  • "two_factor_challenge_uuid": "a00c3b9a-d619-4656-aa93-331bea370651",
  • "code": "123456"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

password send reset link

Отправка ссылки для сброса пароля.

Отправка ссылки доступна не чаще одного раза в минуту (при более частом обращении будет возвращена ошибка с кодом 400). Срок действия токена для сброса пароля: 60 минут.

Request Body schema: application/json
required

Данные для сброса пароля

email
required
string

Email сотрудника

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

password reset

Сброс пароля.

Срок действия токена для сброса пароля: 60 минут.

Request Body schema: application/json
required

Данные для сброса пароля

token
required
string

Токен сброса пароля

email
required
string

Email сотрудника

password
required
string

Новый пароль сотрудника

password_confirmation
required
string

Новый пароль сотрудника ещё раз

Responses

Request samples

Content type
application/json
{
  • "token": "<token>",
  • "email": "test@example.com",
  • "password": "user_password_1984",
  • "password_confirmation": "user_password_1984"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

user

Получение данных аутентифицированного пользователя.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

logout

Деаутентификация пользователя.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

Клиенты

Описание методов для взаимодействия с данными клиентов.

personal data consent template

Возвращает word-файл, представляющий собой бланк согласия на обработку персональных данных с заполненными данными клиента.

Требуются права доступа:

  • CLIENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

query Parameters
template_type
required
string
Default: "common"
Value: ["common","med"]

Тип бланка (common - общий, med - медицинский)

Responses

Response samples

Content type
application/vnd.openxmlformats-officedocument.wordprocessingml.document

В ответе будет возвращён word-файл

docProps/PK.@j24.docProps/app.xml.#PBwR.{nO&.docProps/core.xml}...............

index

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

В данном методе действует ограничение на максимальное количество возвращаемых связей клиентов, а именно:

  • Возвращается не более 5 меток клиента,
  • Возвращается не более 2 контактов клиента,
  • Возвращается не более 1 (крайнего) обращения клиента.

Требуются права доступа:

  • CLIENT_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","full_name","birthday","created_at","updated_at"]
Example: sort_by=full_name

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

birthday_from
string

Минимальная дата рождения клиента в формате dd.mm.YYYY (01.01.2000).

birthday_to
string

Максимальная дата рождения клиента в формате dd.mm.YYYY (01.01.2000).

birthday_day
string

День рождения клиентов в формате dd.mm (31.12).

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у клиента.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у клиента.

has_lead_statuses
Array of integers

Массив идентификаторов статусов обращений, которые ДОЛЖНЫ быть у клиента.

has_no_lead_statuses
Array of integers

Массив идентификаторов статусов обращений, которых НЕ ДОЛЖНО быть у клиента.

contacts
Array of strings

Массив контактов, которые должны быть у клиента.

additional_parameters
Array of strings
Example: additional_parameters=additional_parameters=1;значение 1;значение 2&additional_parameters=2;значение

Массив значние дополнительных данных, которые должны быть у клиента.
Значние ожидаются в виде строк с разделителем в виде ;.
Первое число в строке - идентификатор типа дополнительных данных.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт нового клиента.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_STORE
Authorizations:
BearerToken
Request Body schema: application/json
required

Данные клиента

first_name
required
string

Имя клиента

last_name
required
string

Фамилия клиента

middle_name
string

Отчество клиента

gender
required
integer

Пол клиента (0 - мужчина, 1 - женщина)

birthday
string

Дата рождения клиента

has_personal_data_consent
boolean

Флаг согласия клиента на обработку персональных данных

Array of objects

Массив контактов клиента (не более 50)

Array of objects

Массив дополнительных полей с информацией о клиенте (не более 50)

tags
Array of integers

Массив идентификаторов меток клиента (не более 50)

Responses

Request samples

Content type
application/json
{
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "gender": 0,
  • "birthday": "23.12.1995",
  • "has_personal_data_consent": false,
  • "contacts": [
    ],
  • "additional_parameters": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

bulk destroy

Массовое удаление клиентов.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DESTROY
Authorizations:
BearerToken
Request Body schema: application/json
required
ids
required
Array of integers

Массив идентификаторов

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

show

Возвращает данные клиента.

Требуются права доступа:

  • CLIENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

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

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_STORE
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Request Body schema: application/json
required

Данные клиента

first_name
required
string

Имя клиента

last_name
required
string

Фамилия клиента

middle_name
string

Отчество клиента

gender
required
integer

Пол клиента (0 - мужчина, 1 - женщина)

birthday
string

Дата рождения клиента

has_personal_data_consent
boolean

Флаг согласия клиента на обработку персональных данных

Array of objects

Массив контактов клиента (не более 50)

Array of objects

Массив дополнительных полей с информацией о клиенте (не более 50)

tags
Array of integers

Массив идентификаторов меток клиента (не более 50)

Responses

Request samples

Content type
application/json
{
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "gender": 0,
  • "birthday": "23.12.1995",
  • "has_personal_data_consent": false,
  • "contacts": [
    ],
  • "additional_parameters": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет клиента.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DESTROY
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show metrics

Возвращает метрики клиента.

Требуются права доступа:

  • CLIENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Документы клиентов

Описание методов для взаимодействия с документами клиентов.

documents

Возвращает список документов клиента.

При отсутствии одного или нескольких документов в соответствующих полях возвращается null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show passport

Возвращает данные паспорта РФ клиента.

При отсутствии документа возвращается null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update passport

Обновляет данные паспорта РФ клиента.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_STORE
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Request Body schema: application/json
required

Данные паспорта РФ клиента

series
required
string

Серия паспорта РФ клиента

number
required
string

Номер паспорта РФ клиента

issued_by
required
string

Кем выдан паспорт РФ клиента

issued_at
required
string

Дата выдачи паспорт РФ клиента

division_code
required
string

Код подразделения паспорт РФ клиента

Responses

Request samples

Content type
application/json
{
  • "series": "1234",
  • "number": "567890",
  • "issued_by": "Отделом по выдаче паспортов РФ",
  • "issued_at": "01.01.2000",
  • "division_code": "123-456"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy passport

Удаляет данные паспорта РФ клиента.

Если удаляется несуществующий документ вернётся ответ со статусом 200, а в поле data вернётся null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_DESTROY
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show international_passport

Возвращает данные заграничного паспорта клиента.

При отсутствии документа возвращается null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update international_passport

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

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_STORE
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Request Body schema: application/json
required

Данные заграничного паспорта клиента

last_name
required
string

Фамилия (латиницей) как в заграничном паспорте клиента

first_name
required
string

Имя (латиницей) как в заграничных паспорте клиента

series
required
string

Серия заграничного паспорта клиента

number
required
string

Номер заграничного паспорта клиента

issued_by
required
string

Кем выдан заграничный паспорт клиента

issued_at
required
string

Дата выдачи заграничного паспорта клиента

valid_until
required
string

Срок действия заграничного паспорта клиента

Responses

Request samples

Content type
application/json
{
  • "last_name": "Ivanov",
  • "first_name": "Ivan",
  • "series": "1234",
  • "number": "567890",
  • "issued_by": "Отделом по выдаче заграничных паспортов",
  • "issued_at": "01.01.2000",
  • "valid_until": "01.01.2010"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy international_passport

Удаляет данные заграничного паспорта клиента.

Если удаляется несуществующий документ вернётся ответ со статусом 200, а в поле data вернётся null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_DESTROY
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show snils

Возвращает данные СНИЛС'а клиента.

При отсутствии документа возвращается null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update snils

Обновляет данные СНИЛС'а клиента.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_STORE
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Request Body schema: application/json
required

Данные СНИЛС'а клиента

number
required
string

Номер СНИЛС'а клиента

Responses

Request samples

Content type
application/json
{
  • "number": "123-456-789 00"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy snils

Удаляет СНИЛС клиента.

Если удаляется несуществующий документ вернётся ответ со статусом 200, а в поле data вернётся null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_DESTROY
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show inn

Возвращает данные ИНН'а клиента.

При отсутствии документа возвращается null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update inn

Обновляет данные ИНН'а клиента.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_STORE
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Request Body schema: application/json
required

Данные ИНН'а клиента

number
required
string

Номер ИНН'а клиента

Responses

Request samples

Content type
application/json
{
  • "number": "123456789000"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy inn

Удаляет ИНН клиента.

Если удаляется несуществующий документ вернётся ответ со статусом 200, а в поле data вернётся null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_DESTROY
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show address

Возвращает данные адреса клиента.

При отсутствии документа возвращается null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update address

Обновляет данные адреса клиента.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_STORE
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Request Body schema: application/json
required

Данные адреса клиента

registration
required
string

Адрес регистрации клиента

residential
required
string

Адрес фактического проживания клиента

Responses

Request samples

Content type
application/json
{
  • "registration": "Улица Пушкина, дом Колотушкина, квартира под номером..",
  • "residential": "Улица Пушкина, дом Колотушкина, квартира под номером.."
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy address

Удаляет адрес клиента.

Если удаляется несуществующий документ вернётся ответ со статусом 200, а в поле data вернётся null.

Требуются права доступа:

  • CLIENT_SHOW
  • CLIENT_DOCUMENT_SHOW
  • CLIENT_DOCUMENT_DESTROY
Authorizations:
BearerToken
path Parameters
clientId
required
integer

Идентификатор клиента

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Комментарии

Описание методов для взаимодействия с комментариями.

index

Возвращает список комментариев к указанной сущности.

Требуются права доступа:

  • COMMENT_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

sort_by
string
Value: ["id","created_at","updated_at"]
Example: sort_by=id

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

per_page
integer
Value: [10,25,50]
Example: per_page=25

Количество элементов на странице

commentable_type
required
string
Value: ["App\\Models\\Client","App\\Models\\Lead","App\\Models\\CalendarEvent"]

Класс сущности, к которой относится комментарий.

commentable_id
required
integer

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

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый комментарий.

Требуются права доступа:

  • COMMENT_SHOW
  • COMMENT_STORE
Authorizations:
BearerToken
Request Body schema: application/json

Данные комментария

commentable_type
required
string
Value: ["App\\Models\\Client","App\\Models\\Lead","App\\Models\\CalendarEvent"]

Класс сущности, к которой относится комментарий.

commentable_id
required
integer

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

body
required
string

Текст комментария

reply_comment_id
integer

Уникальный идентификатор комментария, в ответ на который создаётся новые комментарий

Responses

Request samples

Content type
application/json
{
  • "commentable_type": "App\\Models\\Client",
  • "commentable_id": 1,
  • "body": "test",
  • "reply_comment_id": 1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные комментария.

Требуются права доступа:

  • COMMENT_SHOW
Authorizations:
BearerToken
path Parameters
commentId
required
integer
Example: 1

Идентификатор комментария

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет содержимое комментария текущего аутентифицированного сотрудника.

Требуются права доступа:

  • COMMENT_SHOW
  • COMMENT_STORE
Authorizations:
BearerToken
path Parameters
commentId
required
integer
Example: 1

Идентификатор комментария

Request Body schema: application/json

Данные комментария

body
required
string

Текст комментария

Responses

Request samples

Content type
application/json
{
  • "body": "test"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет комментарий.

Если отсутствует право доступа COMMENT_DESTROY_ALL, при запросе на удаление комментария, автором которого не является аутентифицированный сотрудник, будет возвращена ошибка с кодом 404.

Требуются права доступа:

  • COMMENT_SHOW
Authorizations:
BearerToken
path Parameters
commentId
required
integer
Example: 1

Идентификатор комментария

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Фильтры

Описание методов для взаимодействия с фильтрами.

index

Возвращает список публичных фильтров и фильтров текущего аутентифицированного сотрудника по указанному строковому идентификатору.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

sort_by
string
Value: ["id","created_at","updated_at"]
Example: sort_by=id

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

per_page
integer
Value: [10,25,50]
Example: per_page=25

Количество элементов на странице

target
required
string

Строковый идентификатор фильтра.

only_my
boolean
Example: only_my=true

Флаг необходимости возврата только тех фильтров, которые создал текущий аутентифицированный сотрудник.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый фильтр.

Authorizations:
BearerToken
Request Body schema: application/json

Данные фильтра

title
required
string

Название комментария

is_public
required
boolean

Флаг общедоступности фильтра

target
required
string

Текстовый идентификатор фильтра

params
required
string

Параметры фильтра

Responses

Request samples

Content type
application/json
{
  • "title": "Новый фильтр",
  • "is_public": false,
  • "target": "clients_index",
  • "params": "{\"search\":\"\",\"filter_id\":1,\"has_tags[]\":[203,204],\"has_no_tags[]\":[],\"birthday_from\":\"\",\"birthday_to\":\"\"}"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные публичного фильтра, или фильтра текущего аутентифицированного сотрудника.

Authorizations:
BearerToken
path Parameters
filterId
required
integer

Идентификатор фильтра

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

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

Authorizations:
BearerToken
path Parameters
filterId
required
integer

Идентификатор фильтра

Request Body schema: application/json

Данные фильтра

title
required
string

Название комментария

is_public
required
boolean

Флаг общедоступности фильтра

target
required
string

Текстовый идентификатор фильтра

params
required
string

Параметры фильтра

Responses

Request samples

Content type
application/json
{
  • "title": "Новый фильтр",
  • "is_public": false,
  • "target": "clients_index",
  • "params": "{\"search\":\"\",\"filter_id\":1,\"has_tags[]\":[203,204],\"has_no_tags[]\":[],\"birthday_from\":\"\",\"birthday_to\":\"\"}"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет фильтр.

Если отсутствует право доступа FILTER_DESTROY_ALL, при запросе на удаление фильтра, создателем которого не является аутентифицированный сотрудник, будет возвращена ошибка с кодом 404.

Authorizations:
BearerToken
path Parameters
filterId
required
integer

Идентификатор фильтра

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Обращения

Описание методов для взаимодействия с обращениями.

index

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

В данном методе действует ограничение на максимальное количество возвращаемых связей обращений, а именно:

  • Возвращается не более 2 клиентов,
  • Возвращается не более 2 пользователей,
  • Возвращается не более 5 меток.

Требуются права доступа:

  • LEAD_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником обращений дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","title","lead_at","position","created_at","updated_at"]
Example: sort_by=title

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

lead_at_from
string

Минимальная дата обращения в формате dd.mm.YYYY (01.01.2000).

lead_at_to
string

Максимальная дата обращения в формате dd.mm.YYYY (01.01.2000).

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у обращения.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с обращением

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть связаны с обращением

statuses
Array of integers

Массив идентификаторов статусов обращений

source_types
Array of integers

Массив идентификаторов источников обращений

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

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

Требуются права доступа:

  • LEAD_SHOW
  • LEAD_STORE

Дополнительные права доступа:

  • При отсутствии права доступа CLIENT_SHOW полученные в параметре clients клиенты не будут сохранены.
  • При отсутствии права доступа USER_SHOW полученные в параметре users сотрудники не будут сохранены.
Authorizations:
BearerToken
Request Body schema: application/json

Данные обращения

title
required
string

Заголовок обращения

description
string

Примечание к обращению

lead_at
required
string

Дата обращения

source_type_id
required
integer

Уникальный идентификатор источника обращения

status_id
required
integer

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

clients
required
Array of integers

Массив идентификаторов клиентов (не более 50)

users
Array of integers

Массив идентификаторов сотрудников (не более 50)

tags
Array of integers

Массив идентификаторов меток обращения (не более 50)

Responses

Request samples

Content type
application/json
{
  • "title": "Magnam sit labore quia maxime.",
  • "description": "Hic aliquid quis provident quam dolorem enim voluptas.",
  • "lead_at": "01.12.2019",
  • "source_type_id": 8,
  • "status_id": 1,
  • "clients": [
    ],
  • "users": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

bulk destroy

Массовое удаление обращений.

Требуются права доступа:

  • LEAD_SHOW
  • LEAD_DESTROY

Для удаления не связанных с текущим аутентифицированным сотрудником обращений дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
Request Body schema: application/json
required
ids
required
Array of integers

Массив идентификаторов

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

kanban

Возвращает статусы обращений (в количестве, равному параметру statuses_per_page) и обращения с этими статусами.

Предусмотренная в методе пагинация подразумевает постраничное получение статусов обращений. Метод следует использовать для первичного построения и постраничной подгрузки колонок kanban доски. Для получения следующих страниц обращений в каждой колонке следует использовать метод получения обращений с учётом нижеописанного способа формирования списка обращений.

Статусы обращений служат колонками kanban доски.

При формировании списка обращений происходит выборка обращений для каждого статуса. Эта выборка ограничивает обращения для каждого статуса количеством, указанным в параметре leads_per_page, и при их получении использует обратную (descending) сортировку по полю обращений position.

В данном методе действует ограничение на максимальное количество возвращаемых связей обращений, а именно:

  • Возвращается не более 4 клиентов,
  • Возвращается не более 4 пользователей,
  • Возвращается не более 5 меток.
  • Возвращается не более 4 комментариев.

Требуются права доступа:

  • LEAD_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником обращений дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

statuses_per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых статусов обращений.

leads_per_page
integer
Default: 25
Enum: 10 25 50

Кол-во отображаемых обращений для каждого из статусов.

search
string

Произвольный текстовый запрос для поиска записей.

lead_at_from
string

Минимальная дата обращения в формате dd.mm.YYYY (01.01.2000).

lead_at_to
string

Максимальная дата обращения в формате dd.mm.YYYY (01.01.2000).

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у обращения.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у обращения.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с обращением.

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть связаны с обращением.

statuses
Array of integers

Массив идентификаторов статусов обращений.

source_types
Array of integers

Массив идентификаторов источников обращений.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные обращения.

Требуются права доступа:

  • LEAD_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником обращений дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
leadId
required
integer

Идентификатор обращения

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные обращения.

Требуются права доступа:

  • LEAD_SHOW
  • LEAD_STORE

Дополнительные права доступа:

  • При отсутствии права доступа CLIENT_SHOW связанные с обращением клиенты не будут изменены вне зависимости от того, что передано в параметре clients.
  • При отсутствии права доступа USER_SHOW связанные с обращением сотрудники не будут изменены вне зависимости от того, что передано в параметре users.

Для обновления не связанных с текущим аутентифицированным сотрудником обращений дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
leadId
required
integer

Идентификатор обращения

Request Body schema: application/json

Данные обращения

title
required
string

Заголовок обращения

description
string

Примечание к обращению

lead_at
required
string

Дата обращения

source_type_id
required
integer

Уникальный идентификатор источника обращения

status_id
required
integer

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

clients
required
Array of integers

Массив идентификаторов клиентов (не более 50)

users
Array of integers

Массив идентификаторов сотрудников (не более 50)

tags
Array of integers

Массив идентификаторов меток обращения (не более 50)

Responses

Request samples

Content type
application/json
{
  • "title": "Magnam sit labore quia maxime.",
  • "description": "Hic aliquid quis provident quam dolorem enim voluptas.",
  • "lead_at": "01.12.2019",
  • "source_type_id": 8,
  • "status_id": 1,
  • "clients": [
    ],
  • "users": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет обращение.

Требуются права доступа:

  • LEAD_SHOW
  • LEAD_DESTROY

Для удаления не связанных с текущим аутентифицированным сотрудником обращений дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
leadId
required
integer

Идентификатор обращения

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show metrics

Возвращает метрики обращения.

Требуются права доступа:

  • LEAD_SHOW

Для получения метрик не связанного с текущим аутентифицированным сотрудником обращения дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
leadId
required
integer

Идентификатор обращения

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

reorder

Обновляет порядок отображения обращения в Kanban.

Требуются права доступа:

  • LEAD_SHOW
  • LEAD_STORE

Для обновления не связанных с текущим аутентифицированным сотрудником обращений дополнительно требуется право доступа LEAD_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
leadId
required
integer

Идентификатор обращения

Request Body schema: application/json

Данные обращения

status_id
required
integer

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

position
required
integer

Порядок отображения обращения в колонке указанного статуса

Responses

Request samples

Content type
application/json
{
  • "status_id": 1,
  • "position": 4456380
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Уведомления

Описание методов для взаимодействия с уведомлениями аутентифицированного сотрудника.

index

Возвращает список уведомлений аутентифицированного пользователя.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

unread-count

Возвращает количество непрочитанных уведомлений аутентифицированного пользователя.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

read

Помечает указанные уведомления прочитанными.

Если передан положительный флаг all, прочитанными помечаются все непрочитанные уведомления клиента, вне зависимости от того, что передано в notifications. В противном случае прочитанными помечаются только уведомления с идентификаторами, переданными в notifications.

Authorizations:
BearerToken
Request Body schema: application/json

Данные обращения

all
boolean

Флаг необходимости отметить прочитанными ВСЕ непрочитанные уведомления пользователя.

notifications
Array of strings

Массив идентификаторов уведомлений аутентифицированного пользователя, которые необходимо отметить прочитанными.
Обязателен, если в all передано false.

Responses

Request samples

Content type
application/json
{
  • "all": false,
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

show

Возвращает данные уведомления текущего аутентифицированного сотрудника.

Authorizations:
BearerToken
path Parameters
notificationId
required
integer

Идентификатор уведомления

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Права доступа

Описание методов для взаимодействия с правами доступа.

index

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

Требуются права доступа:

  • USER_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50 9999
Example: per_page=25

Количество элементов на странице

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Группы прав доступа

Описание методов для взаимодействия с группами прав доступа.

index

Возвращает список сгруппированных прав доступа системы.

Требуются права доступа:

  • USER_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50 9999
Example: per_page=25

Количество элементов на странице

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Профиль

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

update

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

Authorizations:
BearerToken
Request Body schema: application/json

Флаг активности двухфакторной аутентификации

is_2fa_active
required
boolean

Флаг активности двухфакторной аутентификации

Responses

Request samples

Content type
application/json
{
  • "is_2fa_active": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

activity

Возвращает список логов действий аутентифицированного пользователя.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

sessions index

Возвращает список активных сессий пользователя.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

sessions terminate others

Удаляет все сессии/токены пользователя (кроме текущего).

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

signature

Возвращает подпись/печать аутентифицированного пользователя.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{}

signature change

Обновляет подпись/печать аутентифицированного пользователя.

Для удаления текущих файлов-изображений подписи/печати пользователя без их обновления на другие файлы-изображения следует передавать положительные флаги signature_file_remove и/или stamp_confirmation_file_remove соответственно. Если в запросе эти флаги передаются с отрицательным значением (или не передаются вовсе), а поля signature_file и/или stamp_confirmation_file содержат значение null (или не передаются) - в качестве файлов-изображений подписи/печати пользователя будут использованы те же значения, которые использовались до поступившего запроса.

Authorizations:
BearerToken
Request Body schema: multipart/form-data

Файлы-изображения подписи/печати или флаги их удаления

signature_file
string <binary>

Файл-изображение подписи пользователя

stamp_confirmation_file
string <binary>

Файл-изображение печати пользователя

signature_file_remove
boolean

Флаг необходимости удаления текущего файла-изображения подписи пользователя

stamp_confirmation_file_remove
boolean

Флаг необходимости удаления текущего файла-изображения подписи пользователя

Responses

Request samples

Content type
multipart/form-data
{
  "signature_file_remove": false,
  "stamp_confirmation_file_remove": false
}

Response samples

Content type
application/json
{}

password change

Обновляет пароль аутентифицированного пользователя.

Authorizations:
BearerToken
Request Body schema: application/json

Старый и новый пароль аутентифицированного пользователя

current_password
required
string

Текущий пароль пользователя

new_password
required
string

Новый пароль пользователя

new_password_confirmation
required
string

Новый пароль пользователя ещё раз

Responses

Request samples

Content type
application/json
{
  • "current_password": "Текущий пароль пользователя",
  • "new_password": "Новый пароль пользователя",
  • "new_password_confirmation": "Новый пароль пользователя ещё раз"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

set 2FA active

Устанавливает флаг активности двухфакторной аутентификации аутентифицированного пользователя.

При неподтвержденном email пользователя вернёт ошибку с кодом 400.

Authorizations:
BearerToken
Request Body schema: application/json

Флаг активности двухфакторной аутентификации

is_2fa_active
required
boolean

Флаг активности двухфакторной аутентификации

Responses

Request samples

Content type
application/json
{
  • "is_2fa_active": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

send email verification notification

Отправляет письмо для подтверждения email'а аутентифицированного пользователя.

В случае успеха возвращает email пользователя, на который было отправлено письмо.

При попытке отправить письмо более одного раза в течение минуты вернёт ошибку с кодом 400.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

notification classes

Возвращает список классов доступных уведомлений с информацией о подписке текущего аутентифицированного сотрудника.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update notification class

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

Параметр params имеет уникальные правила валидации для некоторых классов уведомлений:

  • App\Notifications\TodayCalendarEvents — Параметр params.schedule_at является обязательным и должен быть передан в формате "H:i" (наприм.: "20:00").
  • App\Notifications\TomorrowCalendarEvents — Параметр params.schedule_at является обязательным и должен быть передан в формате "H:i" (наприм.: "20:00").
  • App\Notifications\TodayClientsBirthdays — Параметр params.schedule_at является обязательным и должен быть передан в формате "H:i" (наприм.: "20:00").
  • App\Notifications\TomorrowClientsBirthdays — Параметр params.schedule_at является обязательным и должен быть передан в формате "H:i" (наприм.: "20:00").
Authorizations:
BearerToken
path Parameters
notificationClassId
required
integer

Идентификатор класса уведомления

Request Body schema: application/json

Параметры подписки текущего аутентифицированного сотрудника на указанный класс уведомления

notification_channels
required
string

Массив идентификаторов каналов уведомлений, на которые необходимо подписать текущего аутентифицированного сотрудника на указанный класс уведомления.

params
object

Параметры подписки текущего аутентифицированного сотрудника на указанный класс уведомления

Responses

Request samples

Content type
application/json
{
  • "notification_channels": [
    ],
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

Роли

Описание методов для взаимодействия с ролями.

index

Возвращает список пользовательских ролей.

Требуются права доступа:

  • USER_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Value: [10,25,50]
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","title","created_at","updated_at"]
Example: sort_by=title

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новую роль.

Требуются права доступа:

  • USER_SHOW
  • ROLE_STORE
Authorizations:
BearerToken
Request Body schema: application/json

Данные роли

title
required
string

Название роли

description
string

Считает деньги

permissions
Array of integers

Массив уникальных идентификаторов прав доступа, доступных для создаваемой роли

Responses

Request samples

Content type
application/json
{
  • "title": "Бухгалтер",
  • "description": "Считает деньги",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные роли.

Требуются права доступа:

  • USER_SHOW
Authorizations:
BearerToken
path Parameters
roleId
required
integer

Идентификатор роли

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные роли.

Требуются права доступа:

  • USER_SHOW
  • ROLE_STORE
Authorizations:
BearerToken
path Parameters
roleId
required
integer

Идентификатор роли

Request Body schema: application/json

Данные роли

title
required
string

Название роли

description
string

Считает деньги

permissions
Array of integers

Массив уникальных идентификаторов прав доступа, доступных для создаваемой роли

Responses

Request samples

Content type
application/json
{
  • "title": "Бухгалтер",
  • "description": "Считает деньги",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет роль.

Требуются права доступа:

  • USER_SHOW
  • ROLE_DESTROY
Authorizations:
BearerToken
path Parameters
roleId
required
integer

Идентификатор роли

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Поиск

Глобальный поиск по сущностям.

index

По указанному текстовому запросу возвращает не более 3 подходящих результатов поиска для каждой из сущности.

Подстроки текстовых полей возвращаемых сущностей, совпадающие с поисковым запросом, заключаются в тег для выделения цветом на клиентской стороне.

  • При отсутствии права доступа CLIENT_SHOW поле clients не возвращается.
  • При отсутствии права доступа USER_SHOW поле users не возвращается.
Authorizations:
BearerToken
path Parameters
s
required
integer

Произвольный текстовый запрос для поиска записей.

min_score
required
integer

Минимально необходимый процент совпадения модели с поисковым запросом (от 0 до 1)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Статусы

Описание методов для взаимодействия с системными статусами.

index

Возвращает список статусов системы. Возвращаемые статусы отсортированы по полю position в порядке возрастания.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Value: [10,25,50]
Example: per_page=25

Количество элементов на странице

search
string
Example: search=welcome

Поисковая строка

class
string
Example: class=welcome

Класс, который должен быть у статусов.

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый статус.

Требуются права доступа:

  • STATUS_STORE
Authorizations:
BearerToken
Request Body schema: application/json

Данные cтатуса

title
required
string

Название статуса

class
required
string
Value: "LEAD_STATUS"

Класс статуса

color
required
string

Цвет статуса в формате HEX

icon
string

Класс иконки статуса (https://fontawesome.com/search?o=r&m=free)

at
string
Enum: "start" "end"

Указание позиции создаваемого статуса (вставить новый статус в начало или в конец списка)

Responses

Request samples

Content type
application/json
{
  • "title": "Название статуса",
  • "class": "STATUS_CLASS",
  • "color": "#ef820",
  • "icon": "fa-solid fa-status",
  • "at": "start"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные статуса.

Authorizations:
BearerToken
path Parameters
statusId
required
integer

Идентификатор статуса

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные статуса. Для статусов с активным флагом is_system будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • STATUS_STORE
Authorizations:
BearerToken
path Parameters
statusId
required
integer

Идентификатор статуса

Request Body schema: application/json

Данные cтатуса

title
required
string

Название статуса

color
required
string

Цвет статуса в формате HEX

icon
string

Класс иконки статуса (https://fontawesome.com/search?o=r&m=free)

Responses

Request samples

Content type
application/json
{
  • "title": "Название статуса",
  • "color": "#ef820",
  • "icon": "fa-solid fa-status"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет статус. Для статусов с активным флагом is_system будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • STATUS_DESTROY
Authorizations:
BearerToken
path Parameters
statusId
required
integer

Идентификатор статуса

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

reorder

Обновляет позицию статуса.

Требуются права доступа:

  • STATUS_STORE
Authorizations:
BearerToken
path Parameters
statusId
required
integer

Идентификатор статуса

Request Body schema: application/json

Новая позиция cтатуса

position
required
integer

Новая позиция cтатуса

Responses

Request samples

Content type
application/json
{
  • "position": 1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

classes

Возвращает список классов статусов системы.

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

Типы

Описание методов для взаимодействия с системными типами.

index

Возвращает список типов системы. Возвращаемые типы отсортированы по полю position в порядке возрастания.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Value: [10,25,50]
Example: per_page=25

Количество элементов на странице

search
string
Example: search=welcome

Поисковая строка

class
string
Example: class=welcome

Класс, который должен быть у статусов.

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новый тип.

Требуются права доступа:

  • TYPE_STORE
Authorizations:
BearerToken
Request Body schema: application/json

Данные типа

title
required
string

Название статуса

class
required
string
Enum: "LEAD_SOURCE_TYPE" "CONTACT_TYPE" "CALENDAR_EVENT_TYPE" "ADDITIONAL_PARAMETER_TYPE"

Класс статуса

color
required
string

Цвет статуса в формате HEX

icon
string

Класс иконки статуса (https://fontawesome.com/search?o=r&m=free)

at
string
Enum: "start" "end"

Указание позиции создаваемого типа (вставить новый статус в начало или в конец списка)

Responses

Request samples

Content type
application/json
{
  • "title": "Название типа",
  • "class": "TYPE_CLASS",
  • "color": "#4C75A3",
  • "icon": "fa-brands fa-type-class",
  • "at": "start"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные типа.

Authorizations:
BearerToken
path Parameters
typeId
required
integer

Идентификатор типа

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

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

Требуются права доступа:

  • TYPE_STORE
Authorizations:
BearerToken
path Parameters
typeId
required
integer

Идентификатор типа

Request Body schema: application/json

Данные cтатуса

title
required
string

Название типа

color
required
string

Цвет типа в формате HEX

icon
string

Класс иконки типа (https://fontawesome.com/search?o=r&m=free)

Responses

Request samples

Content type
application/json
{
  • "title": "Название типа",
  • "color": "#4C75A3",
  • "icon": "fa-brands fa-type-class"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет тип. Для типов с активным флагом is_system будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • TYPE_DESTROY
Authorizations:
BearerToken
path Parameters
typeId
required
integer

Идентификатор типа

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

reorder

Обновляет позицию типа.

Требуются права доступа:

  • TYPE_STORE
Authorizations:
BearerToken
path Parameters
typeId
required
integer

Идентификатор типа

Request Body schema: application/json

Новая позиция типа

position
required
integer

Новая позиция типа

Responses

Request samples

Content type
application/json
{
  • "position": 7
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

classes

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

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

Системные события

Описание методов для взаимодействия с логами системных событий.

index

Возвращает хронологию действий сотрудников системы.

Если отсутствует право доступа SYSTEM_EVENTS_SHOW_ALL, будут возвращены только действия аутентифицированного пользователя.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

client_id
integer
Example: client_id=1

Уникальный идентификатор клиента, события, связанные с которым, необходимо получить

user_id
integer
Example: user_id=1

Уникальный идентификатор пользователя, события, связанные с которым, необходимо получить

data_models
Array of arrays
Example: data_models=App\Models\Client

Уникальный идентификатор пользователя, события, связанные с которым, необходимо получить

data_model_ids
Array of arrays

Массив идентификаторов моделей, с которыми должны быть связаны системные события

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает лог пользовательского действия (системного события) для подробного просмотра.

Если лог не относиться к действию текущего аутентифицированного сотрудника и у сотрудника нет прав SYSTEM_EVENTS_SHOW_ALL - будет возвращена ошибка с кодом 400.

Authorizations:
BearerToken
path Parameters
systemEventId
required
integer

Идентификатор системного события

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Метки

Описание методов для взаимодействия с метками.

index

Возвращает список меток. Возвращаемые метки отсортированы по полям class и position в порядке возрастания.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Value: [10,25,50]
Example: per_page=25

Количество элементов на странице

search
string
Example: search=welcome

Поисковая строка

class
Array of strings
Example: class=TAG_CLASS

Массив классов, которые должны быть у меток.

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новую метку.

Требуются права доступа:

  • TAG_STORE
Authorizations:
BearerToken
Request Body schema: application/json

Данные метки

title
required
string

Название метки

class
required
string
Enum: "COMMON_TAG" "CLIENT_TAG" "LEAD_TAG"

Класс метки

color
required
string

Цвет метки в формате HEX

at
string
Enum: "start" "end"

Указание позиции создаваемой метки (вставить новую метку в начало или в конец списка)

Responses

Request samples

Content type
application/json
{
  • "title": "Название тега",
  • "class": "TAG_CLASS",
  • "color": "#915935",
  • "at": "start"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные метки.

Authorizations:
BearerToken
path Parameters
tagId
required
integer

Идентификатор метки

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные метки.

Требуются права доступа:

  • TAG_STORE
Authorizations:
BearerToken
path Parameters
tagId
required
integer

Идентификатор метки

Request Body schema: application/json

Данные метки

title
required
string

Название метки

class
required
string
Enum: "COMMON_TAG" "CLIENT_TAG" "LEAD_TAG"

Класс метки

color
required
string

Цвет метки в формате HEX

Responses

Request samples

Content type
application/json
{
  • "title": "Название тега",
  • "class": "TAG_CLASS",
  • "color": "#915935"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет метку.

Требуются права доступа:

  • TAG_DESTROY
Authorizations:
BearerToken
path Parameters
tagId
required
integer

Идентификатор метки

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

reorder

Обновляет позицию метки.

Authorizations:
BearerToken
path Parameters
tagId
required
integer

Идентификатор метки

Request Body schema: application/json

Новая позиция метки

position
required
integer

Новая позиция метки

Responses

Request samples

Content type
application/json
{
  • "position": 24
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

classes

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

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

Сотрудники

Описание методов для взаимодействия с сотрудниками.

index

Возвращает список пользователей.

В данном методе действует ограничение на максимальное количество возвращаемых связей пользователей, а именно:

  • Возвращается не более 3 ролей пользователя,

Требуются права доступа:

  • USER_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","full_name","email","birthday","created_at","updated_at"]
Example: sort_by=full_name

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

birthday_from
string

Минимальная дата рождения пользователя в формате dd.mm.YYYY (01.01.2000).

birthday_to
string

Максимальная дата рождения пользователя в формате dd.mm.YYYY (01.01.2000).

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт нового пользователя.

Требуются права доступа:

  • USER_SHOW
  • USER_STORE
Authorizations:
BearerToken
Request Body schema: application/json

Данные пользователя

first_name
required
string

Имя пользователя

last_name
required
string

Фамилия пользователя

middle_name
string

Отчество пользователя

gender
required
integer

Пол пользователя (0 - мужчина, 1 - женщина)

birthday
string

Дата рождения пользователя

email
required
string

Email пользователя

password
required
string

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

password_confirmation
required
string

Пароль пользователя ещё раз

is_super_admin
required
boolean

Признак наличия у сотрудника полного доступа ко всем разделам системы

roles
Array of integers

Массив идентификаторов ролей пользователя (не более 50)

Responses

Request samples

Content type
application/json
{
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "gender": 0,
  • "birthday": "30.12.1995",
  • "email": "test@example.com",
  • "password": "user_password_1984",
  • "password_confirmation": "user_password_1984",
  • "is_super_admin": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

bulk destroy

Массовое удаление пользователей.

Требуются права доступа:

  • USER_SHOW
  • USER_DESTROY
Authorizations:
BearerToken
Request Body schema: application/json
required
ids
required
Array of integers

Массив идентификаторов

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}

show

Возвращает данные пользователя.

При попытке получить данные аутентифицированного пользователя будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • USER_SHOW
Authorizations:
BearerToken
path Parameters
userId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные пользователя.

При попытке изменить данные аутентифицированного пользователя будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • USER_SHOW
  • USER_STORE
Authorizations:
BearerToken
path Parameters
userId
required
integer

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

Request Body schema: application/json

Данные пользователя

first_name
required
string

Имя пользователя

last_name
required
string

Фамилия пользователя

middle_name
string

Отчество пользователя

gender
required
integer

Пол пользователя (0 - мужчина, 1 - женщина)

birthday
string

Дата рождения пользователя

email
required
string

Email пользователя

is_super_admin
required
boolean

Признак наличия у сотрудника полного доступа ко всем разделам системы

roles
Array of integers

Массив идентификаторов ролей пользователя (не более 50)

Responses

Request samples

Content type
application/json
{
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "gender": 0,
  • "birthday": "30.12.1995",
  • "email": "test@example.com",
  • "is_super_admin": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет пользователя.

При попытке удалить аутентифицированного пользователя будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • USER_SHOW
  • USER_DESTROY
Authorizations:
BearerToken
path Parameters
userId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

password change

Обновляет пароль пользователя.

При попытке изменить пароль аутентифицированного пользователя будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • USER_SHOW
  • USER_STORE
Authorizations:
BearerToken
path Parameters
userId
required
integer

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

Request Body schema: application/json

Данные пользователя

password
required
string

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

password_confirmation
required
string

Пароль пользователя ещё раз

Responses

Request samples

Content type
application/json
{
  • "password": "user_password_1984",
  • "password_confirmation": "user_password_1984"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

deactivate

Деактивация сотрудника

При попытке деактивировать аутентифицированного пользователя будет возвращена ошибка с кодом 400.

Требуются права доступа:

  • USER_SHOW
  • USER_STORE
Authorizations:
BearerToken
path Parameters
userId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

activate

Активация ранее деактивированного сотрудника

Требуются права доступа:

  • USER_SHOW
  • USER_STORE
Authorizations:
BearerToken
path Parameters
userId
required
integer

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

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

Описание методов для взаимодействия с календарными событиями.

index

Возвращает список календарных событий.

  • Возвращается не более 2 клиентов календарного события
  • Возвращается не более 5 меток календарного события

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником календарных событий, дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","start_at","end_at","created_at","updated_at"]
Example: sort_by=start_at

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

date_from
string

Начало запрашиваемого периода (прим. "01.01.2024")

date_to
string

Окончание запрашиваемого периода (прим. "31.01.2024").

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с календарным событием

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть связаны с календарным событием

creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий

users_or_creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий, или должны быть связаны с ними

statuses
Array of integers

Массив идентификаторов статусов календарных событий

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у календарных событий.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у календарных событий.

types
Array of integers

Массив идентификаторов типов календарных событий

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

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

Требуются права доступа:

  • CALENDAR_EVENT_SHOW
  • CALENDAR_EVENT_STORE

Дополнительные права доступа:

  • При отсутствии права доступа CLIENT_SHOW полученные в параметре clients клиенты не будут сохранены.
  • При отсутствии права доступа LEAD_SHOW полученные в параметре leads обращения не будут сохранены.
  • При отсутствии права доступа USER_SHOW полученные в параметре users сотрудники не будут сохранены.
Authorizations:
BearerToken
Request Body schema: application/json

Данные календарного события

title
required
string

Заголовок календарного события

description
string

Описание календарного события

start_at
required
string

Дата и время начала календарного события

end_at
required
string

Дата и время окончания календарного события

type_id
required
integer

Идентификатор типа календарного события

status_id
required
integer

Идентификатор статуса календарного события

clients
Array of integers

Массив идентификаторов клиентов, связанных с календарным событием (не более 50)

leads
Array of integers

Массив идентификаторов обращений, связанных с календарным событием (не более 50)

users
Array of integers

Массив идентификаторов пользователей, связанных с календарным событием (не более 50)

tags
Array of integers

Массив идентификаторов меток, связанных с календарным событием (не более 50)

Responses

Request samples

Content type
application/json
{
  • "title": "Новое календарное событие",
  • "description": "Описание нового календарного события",
  • "start_at": "20.02.2024",
  • "end_at": "20.02.2024",
  • "type_id": 8,
  • "status_id": 1,
  • "clients": [
    ],
  • "leads": [
    ],
  • "tags": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

busy days

Возвращает список дат для которых есть календарные события за указанный год.

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для получения списка дат, для которых есть не связанные с текущим аутентифицированным сотрудником календарные события, дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
year
required
string

Запрашиваемый год (прим. "2024").

date_from
string

Начало запрашиваемого периода (прим. "01.01.2024").

date_to
string

Окончание запрашиваемого периода (прим. "31.01.2024").

search
string

Произвольный текстовый запрос для поиска записей.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с календарным событием.

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть связаны с календарным событием.

creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий.

users_or_creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий, или должны быть связаны с ними.

statuses
Array of integers

Массив идентификаторов статусов календарных событий.

types
Array of integers

Массив идентификаторов типов календарных событий.

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у календарных событий.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у календарных событий.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

by month

Возвращает список календарных событий за указанный месяц. Если передан признак adjacent - дополнительно вернутся события за 7 дней до и 7 дней после указанного месяца.

Возвращается не более 10 событий за один календарный день!

  • Возвращается не более 5 меток календарного события

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником календарных событий, дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
month
required
string

Запрашиваемый месяц (прим. "01.2024").

adjacent
boolean

Признак необходимости возвращения событий 7-ми прилегающих к указанному месяцу дней.

search
string

Произвольный текстовый запрос для поиска записей.

date_from
string

Начало запрашиваемого периода (прим. "01.01.2024").

date_to
string

Окончание запрашиваемого периода (прим. "31.01.2024").

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с календарным событием.

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть связаны с календарным событием.

creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий.

users_or_creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий, или должны быть связаны с ними.

statuses
Array of integers

Массив идентификаторов статусов календарных событий.

types
Array of integers

Массив идентификаторов типов календарных событий.

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у календарных событий.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у календарных событий.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

by period

Возвращает список календарных событий за указанный период. Если требуется получить календарные события за один день, в параметры date_from и date_to следует передавать одинаковую дату.

  • Возвращается не более 4 клиентов календарного события
  • Возвращается не более 5 меток календарного события
  • Возвращается не более 4 комментариев календарного события

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником календарных событий, дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
date_from
required
string

Начало запрашиваемого периода (прим. "01.01.2024").

date_to
required
string

Окончание запрашиваемого периода (прим. "31.01.2024").

page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "start_at"
Enum: "id" "title" "start_at" "end_at" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50 100 250

Кол-во отображаемых записей на странице.

search
string

Произвольный текстовый запрос для поиска записей.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с календарным событием.

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть связаны с календарным событием.

creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий.

users_or_creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий, или должны быть связаны с ними.

statuses
Array of integers

Массив идентификаторов статусов календарных событий.

types
Array of integers

Массив идентификаторов типов календарных событий.

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у календарных событий.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у календарных событий.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

by period union

Возвращает список календарных событий и других календарных сущностей за указанный период. Календарные события сортируются по полю start_at в порядке, указанном в параметре descending.

Логика возвращения сущностей, отличных от календарных событий, и условия их возвращения (в т.ч. требуемые права доступа), регулируется в модулях.

В возвращаемом параметре sort_data указывается единый порядок всех возвращенных сущностей согласно параметрам сортировки.

Если требуется получить события за один день, в параметры date_from и date_to следует передавать одинаковую дату.

  • Возвращается не более 4 клиентов календарного события
  • Возвращается не более 5 меток календарного события
  • Возвращается не более 4 комментариев календарного события

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для получения не связанных с текущим аутентифицированным сотрудником календарных событий, дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
date_from
required
string

Начало запрашиваемого периода (прим. "01.01.2024").

date_to
required
string

Окончание запрашиваемого периода (прим. "31.01.2024").

page
integer

Номер страницы (для постраничной пагинации).

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50 100 250

Кол-во отображаемых записей на странице.

search
string

Произвольный текстовый запрос для поиска записей.

clients
Array of integers

Массив идентификаторов клиентов, которые должны быть связаны с календарным событием.

users
Array of integers

Массив идентификаторов сотрудников, которые должны быть связаны с календарным событием.

creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий.

users_or_creators
Array of integers

Массив идентификаторов сотрудников, которые должны быть создателями календарных событий, или должны быть связаны с ними.

statuses
Array of integers

Массив идентификаторов статусов календарных событий.

types
Array of integers

Массив идентификаторов типов календарных событий.

has_tags
Array of integers

Массив идентификаторов меток, которые ДОЛЖНЫ быть у календарных событий.

has_no_tags
Array of integers

Массив идентификаторов меток, которых НЕ ДОЛЖНО быть у календарных событий.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные календарного события.

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для просмотра календарных событий, не связанных с аутентифицированным сотрудником, дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
calendarEventId
required
integer

Идентификатор календарного события

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные календарного события.

Требуются права доступа:

  • CALENDAR_EVENT_SHOW
  • CALENDAR_EVENT_STORE

Дополнительные права доступа:

  • При отсутствии права доступа CLIENT_SHOW связанные с календарным событием клиенты не будут изменены вне зависимости от того, что передано в параметре clients.
  • При отсутствии права доступа LEAD_SHOW связанные с календарным событием обращения не будут изменены вне зависимости от того, что передано в параметре leads.
  • При отсутствии права доступа USER_SHOW связанные с календарным событием сотрудники не будут изменены вне зависимости от того, что передано в параметре users.

Для обновления не связанных с аутентифицированным сотрудником календарных событий дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
calendarEventId
required
integer

Идентификатор календарного события

Request Body schema: application/json

Данные календарного события

title
required
string

Заголовок календарного события

description
string

Описание календарного события

start_at
required
string

Дата и время начала календарного события

end_at
required
string

Дата и время окончания календарного события

type_id
required
integer

Идентификатор типа календарного события

status_id
required
integer

Идентификатор статуса календарного события

clients
Array of integers

Массив идентификаторов клиентов, связанных с календарным событием (не более 50)

leads
Array of integers

Массив идентификаторов обращений, связанных с календарным событием (не более 50)

users
Array of integers

Массив идентификаторов пользователей, связанных с календарным событием (не более 50)

tags
Array of integers

Массив идентификаторов меток, связанных с календарным событием (не более 50)

Responses

Request samples

Content type
application/json
{
  • "title": "Новое календарное событие",
  • "description": "Описание нового календарного события",
  • "start_at": "20.02.2024",
  • "end_at": "20.02.2024",
  • "type_id": 8,
  • "status_id": 1,
  • "clients": [
    ],
  • "leads": [
    ],
  • "tags": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

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

Требуются права доступа:

  • CALENDAR_EVENT_SHOW
  • CALENDAR_EVENT_DESTROY

Для удаления не связанных с текущим аутентифицированным сотрудником календарных событий дополнительно требуется право доступа CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
calendarEventId
required
integer

Идентификатор календарного события

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Подтверждения календарных событий

Описание методов для взаимодействия с подтверждениями календарных событий.

index

Возвращает список подтверждений календарного события.

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для получения подтверждений не связанных с текущим аутентифицированным сотрудником календарных событий дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","state","created_at","updated_at"]
Example: sort_by=state

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

calendar_event_id
required
integer

Идентификатор календарного события.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новое подтверждение календарного события.

Требуются права доступа:

  • CALENDAR_EVENT_SHOW
  • CALENDAR_EVENT_STORE

Для создания подтверждения не связанного с текущим аутентифицированным сотрудником календарного события дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
Request Body schema: application/json

Данные подтверждения календарного события

state
required
string
Value: ["confirmed","cancelled"]

Статус подтверждения календарного события

calendar_event_id
required
string

Идентификатор календарного событие, для которого создаётся подтверждение

clients
required
Array of integers

Массив идентификаторов клиентов, для которых создаётся подтверждение календарного события (не более 50)

Responses

Request samples

Content type
application/json
{
  • "state": "confirmed",
  • "calendar_event_id": 1,
  • "clients": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

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

Требуются права доступа:

  • CALENDAR_EVENT_SHOW

Для просмотра подтверждения календарного события, не связанного с аутентифицированным сотрудником, дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
calendarEventConfirmationId
required
integer

Идентификатор подтверждения календарного события

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные подтверждения календарного события.

Требуются права доступа:

  • CALENDAR_EVENT_SHOW
  • CALENDAR_EVENT_STORE

Для обновления подтверждений не связанных с аутентифицированным сотрудником календарных событий дополнительно требуется право CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
calendarEventConfirmationId
required
integer

Идентификатор подтверждения календарного события

Request Body schema: application/json

Данные подтверждения календарного события

state
required
string
Value: ["confirmed","cancelled"]

Статус подтверждения календарного события

Responses

Request samples

Content type
application/json
{
  • "state": "confirmed"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет подтверждение календарного события.

Требуются права доступа:

  • CALENDAR_EVENT_SHOW
  • CALENDAR_EVENT_STORE

Для удаления подтверждений не связанных с текущим аутентифицированным сотрудником календарных событий дополнительно требуется право доступа CALENDAR_EVENT_SHOW_ALL.

Authorizations:
BearerToken
path Parameters
calendarEventConfirmationId
required
integer

Идентификатор подтверждения календарного события

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Дополнительные данные сущностей

Описание методов для взаимодействия с дополнительными данными сущностей.

values

Возвращает список значений дополнительных данных.

На данный момент дополнительные данные есть только у клиентов.

Требуются права доступа:

  • CLIENT_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

descending
boolean
Example: descending=true

Сортировка по убыванию

per_page
integer
Value: [10,25,50]
Example: per_page=25

Количество элементов на странице

search
string
Example: search=welcome

Поисковая строка

type_id
integer

Идентификатор типа доп. поля (для фильтрации).

Responses

Response samples

Content type
application/json
{}

Статистика

Описание методов для взаимодействия со статистикой.

leads prepare

Создаёт фоновую задачу на расчёт статистики обращений.

Требуются права доступа:

  • STATISTIC_SHOW
  • LEADS_STATISTIC_SHOW

Если не передан параметр lead_at_from и/или lead_at_to, будет сгенерирована статистика за всё время.

В результате выполнения будет возвращён объект фоновой задачи. Процесс выполнения фоновой задачи следует отслеживать с помощью соответствующего метода.

При успешном расчёте статистики полученный объект фоновой задачи будет иметь следующую структуру поля result:

{
  "type": "leads_statistic", // Тип статистики
  "params": { // Параметры, с учётом которых рассчитана статистики
    "lead_at_from": "01.01.2025",
    "lead_at_to": "31.01.2025"
  },
  "leads": {
    "total": 3, // Всего обращений
    "ids": [1, 2, 3] // Идентификаторы обращений
  },
  "clients": {
    "total": 3, // Всего клиентов
    "ids":  [1, 2, 3] // Идентификаторы клиентов
  },
  "lead_source_types": { // Источники обращений
    "summary": [ // Сводно
      {
        "id": 1, // Идентификатор типа источника обращений
        "title": "Прочее", // Заголовок типа источника обращений
        "color": "#cccccc", // Цвет типа источника обращений
        "leads_total": 2, // Всего обращений с указанным типом источника обращений
        "leads_ids": [1, 2] // Идентификаторы обращений с указанным типом источника обращений
      }
    ],
    "dynamic": [ // В динамике с разбивкой по месяцам
      {
        "month": "01.2025", // Месяц/Год
        "source_types": [ // Массив типов источников обращений
          {
            "id": 1, // Идентификатор типа источника обращений
            "title": "Прочее", // Заголовок типа источника обращений
            "color": "#cccccc", // Цвет типа источника обращений
            "leads_total": 2, // Всего обращений с указанным типом источника обращений в соответствующем месяце/году
            "leads_ids": [1, 2] // Идентификаторы обращений с указанным типом источника обращений в соответствующем месяце/году
          }
        ]
      }
    ]
  },
  "lead_statuses": { // Статусы обращений
    "summary": [ // Сводно
      {
        "id": 1, // Идентификатор статуса обращений
        "title": "Новое", // Заголовок статуса обращений
        "color": "#cccccc", // Цвет статуса обращений
        "leads_total": 2, // Всего обращений с указанным статусом обращений
        "leads_ids": [1, 2] // Идентификаторы обращений с указанным статусом обращений
      }
    ]
  },
  "calendar_event_types": [ // Типы календарных событий
    {
      "id": 1, // Идентификатор типа календарного события
      "title": "Консультация первичная", // Заголовок типа календарного события
      "color": "#fff", // Цвет типа календарного события
      "statuses": [ // Статусы календарных событий
        {
          "id": 1, // Идентификатор статуса календарного события
          "title": "Запланировано", // Заголовок статуса календарного события
          "color": "#cccccc", // Цвет статуса календарного события
          "calendar_events_total": 2, // Всего календарных событий с соответствующим типом и статусом
          "calendar_events_ids": [1, 2], // Идентификаторы календарных событий с соответствующим типом и статусом
        }
      ]
    }
  ]
}
Authorizations:
BearerToken
Request Body schema: application/json

Данные обращений

lead_at_from
string

Минимальная дата обращения в формате dd.mm.YYYY.

lead_at_to
integer

Максимальная дата обращения в формате dd.mm.YYYY.

Responses

Request samples

Content type
application/json
{
  • "lead_at_from": "01.01.2025",
  • "lead_at_to": "31.01.2025"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

clients prepare

Создаёт фоновую задачу на расчёт статистики клиентов.

Требуются права доступа:

  • STATISTIC_SHOW
  • CLIENTS_STATISTIC_SHOW

Если не передан параметр created_at_from и/или created_at_to, будет сгенерирована статистика за всё время.

В результате выполнения будет возвращён объект фоновой задачи. Процесс выполнения фоновой задачи следует отслеживать с помощью соответствующего метода.

При успешном расчёте статистики полученный объект фоновой задачи будет иметь следующую структуру поля result:

{
  "type": "clients_statistic", // Тип статистики
  "params": { // Параметры, с учётом которых рассчитана статистики
    "created_at_from": "01.01.2025",
    "created_at_to": "31.01.2025"
  },
  "clients": {
    "total": 3, // Всего клиентов
    "ids":  [1, 2, 3] // Идентификаторы клиентов
  },
  "leads": {
    "total": 3, // Всего обращений
    "ids": [1, 2, 3] // Идентификаторы обращений
  },
  "lead_source_types": { // Источники обращений
    "summary": [ // Сводно
      {
        "id": 1, // Идентификатор типа источника обращений
        "title": "Прочее", // Заголовок типа источника обращений
        "color": "#cccccc", // Цвет типа источника обращений
        "leads_total": 2, // Всего обращений с указанным типом источника обращений
        "leads_ids": [1, 2] // Идентификаторы обращений с указанным типом источника обращений
      }
    ],
    "dynamic": [ // В динамике с разбивкой по месяцам
      {
        "month": "01.2025", // Месяц/Год
        "source_types": [ // Массив типов источников обращений
          {
            "id": 1, // Идентификатор типа источника обращений
            "title": "Прочее", // Заголовок типа источника обращений
            "color": "#cccccc", // Цвет типа источника обращений
            "leads_total": 2, // Всего обращений с указанным типом источника обращений в соответствующем месяце/году
            "leads_ids": [1, 2] // Идентификаторы обращений с указанным типом источника обращений в соответствующем месяце/году
          }
        ]
      }
    ]
  },
  "lead_statuses": { // Статусы обращений
    "summary": [ // Сводно
      {
        "id": 1, // Идентификатор статуса обращений
        "title": "Новое", // Заголовок статуса обращений
        "color": "#cccccc", // Цвет статуса обращений
        "leads_total": 2, // Всего обращений с указанным статусом обращений
        "leads_ids": [1, 2] // Идентификаторы обращений с указанным статусом обращений
      }
    ]
  },
  "calendar_event_types": [ // Типы календарных событий
    {
      "id": 1, // Идентификатор типа календарного события
      "title": "Консультация первичная", // Заголовок типа календарного события
      "color": "#fff", // Цвет типа календарного события
      "statuses": [ // Статусы календарных событий
        {
          "id": 1, // Идентификатор статуса календарного события
          "title": "Запланировано", // Заголовок статуса календарного события
          "color": "#cccccc", // Цвет статуса календарного события
          "calendar_events_total": 2, // Всего календарных событий с соответствующим типом и статусом
          "calendar_events_ids": [1, 2], // Идентификаторы календарных событий с соответствующим типом и статусом
        }
      ]
    }
  ]
}
Authorizations:
BearerToken
Request Body schema: application/json

Данные клиентов

created_at_from
string

Минимальная дата создания клиента в формате dd.mm.YYYY.

created_at_to
integer

Максимальная дата создания клиента в формате dd.mm.YYYY.

Responses

Request samples

Content type
application/json
{
  • "created_at_from": "01.01.2025",
  • "created_at_to": "31.01.2025"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Фоновые задачи

Описание методов для взаимодействия с фоновыми задачами.

index

Возвращает список фоновых задач аутентифицированного пользователя.

Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 5 10

Кол-во отображаемых записей на странице.

types
Array of strings

Массив типов, которые должны быть у фоновой задачи.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные фоновой задачи аутентифицированного пользователя.

Authorizations:
BearerToken
path Parameters
batchId
required
integer

Идентификатор фоновой задачи

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Оператор ПДн

Описание методов для взаимодействия с юридическими данными оператора ПДн.

show

Возвращает юридические данные оператора ПДн.

При отсутствии данных возвращается null.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет юридические данные оператора ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json

Данные роли

processing_start_at
string

Дата начала обработки ПДн

region_id
string

Регион регистрации оператора ПДн

cross_border_transfer
boolean

Трансграничная передача

inn
string

ИНН оператора ПДн

legal_zip
string

Почтовый индекс города регистрации оператора ПДн

legal_city
string

Город регистрации оператора ПДн

legal_address
string

Адрес регистрации оператора ПДн

postal_zip
string

Почтовый индекс почтового города оператора ПДн

postal_city
string

Почтовый город оператора ПДн

postal_address
string

Почтовый адрес оператора ПДн

contact_phone
string

Контактный телефон оператора ПДн

contact_email
string

Контактный email оператора ПДн

legal_form
string
Enum: "Физлицо" "ИП" "ООО"

Организационно-правовая форма оператора ПДн

first_name
string

Имя. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица оператора ПДн.

last_name
string

Фамилия. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица оператора ПДн.

middle_name
string

Отчество. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица оператора ПДн.

birthdate
string

Дата рождения. Обязательно для физлица и ИП.

passport_series
string

Серия паспорта. Обязательно для физлица и ИП.

passport_number
string

Номер паспорта. Обязательно для физлица и ИП.

passport_issued_by
string

Кем выдан паспорт. Обязательно для физлица и ИП.

passport_issued_at
string

Дата выдачи паспорта. Обязательно для физлица и ИП.

passport_division_code
string

Код подразделения паспорта. Обязательно для физлица и ИП.

title
required
string

Название оператора ПДн (обязательное поле для ИП и ООО)

ogrnip
string

ОГРНИП оператора ПДн (обязательное поле для ИП)

registered_at
string

Дата регистрации оператора ПДн (обязательное поле для ИП)

ogrn
string

ОГРН оператора ПДн (обязательное поле для ООО)

reason
string

"Действующее на основании" для действующего лица ООО (обязательное поле для ООО)

Responses

Request samples

Content type
application/json
{
  • "processing_start_at": "01.01.2000",
  • "region_id": 1,
  • "cross_border_transfer": 0,
  • "inn": "1234567890",
  • "legal_zip": 123456,
  • "legal_city": "Москва",
  • "legal_address": "Ул. Пушкина, д. Колотушкина",
  • "postal_zip": 123456,
  • "postal_city": "Москва",
  • "postal_address": "Ул. Пушкина, д. Колотушкина",
  • "contact_phone": "7123456789",
  • "contact_email": "test@gmail.com",
  • "legal_form": "ИП",
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "birthdate": "01.01.2000",
  • "passport_series": "1234",
  • "passport_number": "567890",
  • "passport_issued_by": "Отделом УФМС России по городу Понивилль",
  • "passport_issued_at": "01.01.2014",
  • "passport_division_code": "123-456",
  • "title": "ИП Иванов Иван Иванович",
  • "ogrnip": "123456789012345",
  • "registered_at": "01.01.2000",
  • "ogrn": "1234567890123",
  • "reason": "Устава"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Ответственное лицо оператора ПДн

Описание методов для взаимодействия с юридическими данными ответственного лица оператора ПДн.

show

Возвращает юридические данные ответственного лица оператора ПДн.

При отсутствии данных возвращается null.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет юридические данные ответственного лица оператора ПДн.

Поля legal_form, inn, postal_address, contact_phone, contact_email, first_name, last_name, middle_name, birthdate, passport_series, passport_number, passport_issued_by, passport_issued_at, passport_division_code - обязательны только при активном флаге same_as_legal_operator.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json

Данные роли

same_as_legal_operator
required
boolean

Флаг использования данных оператора в качестве данных ответственного лица оператора ПДн

order_number
required
string

Номер приказа о назначении ответственного лица оператора ПДн

order_date
required
string

Дата приказа о назначении ответственного лица оператора ПДн

inn
required
string

ИНН ответственного лица оператора ПДн

legal_zip
string

Почтовый индекс города регистрации ответственного лица оператора ПДн

legal_city
required
string

Город регистрации ответственного лица оператора ПДн

legal_address
required
string

Адрес регистрации ответственного лица оператора ПДн

postal_zip
string

Почтовый индекс почтового города ответственного лица оператора ПДн

postal_city
required
string

Почтовый город ответственного лица оператора ПДн

postal_address
required
string

Почтовый адрес ответственного лица оператора ПДн

contact_phone
required
string

Контактный телефон ответственного лица оператора ПДн

contact_email
required
string

Контактный email ответственного лица оператора ПДн

legal_form
required
string
Enum: "Физлицо" "ИП"

Организационно-правовая форма ответственного лица оператора ПДн

first_name
required
string

Имя. Для физлица и ИП — собственные паспортные данные.

last_name
required
string

Фамилия. Для физлица и ИП — собственные паспортные данные.

middle_name
required
string

Отчество. Для физлица и ИП — собственные паспортные данные.

birthdate
required
string

Дата рождения. Для физлица и ИП — собственные паспортные данные.

passport_series
required
string

Серия паспорта. Для физлица и ИП — собственные паспортные данные.

passport_number
required
string

Номер паспорта. Для физлица и ИП — собственные паспортные данные.

passport_issued_by
required
string

Кем выдан паспорт. Для физлица и ИП — собственные паспортные данные.

passport_issued_at
required
string

Дата выдачи паспорта. Для физлица и ИП — собственные паспортные данные.

passport_division_code
required
string

Код подразделения паспорта. Для физлица и ИП — собственные паспортные данные.

title
string

Название ответственного лица оператора ПДн (обязательное поле для ИП)

ogrnip
string

ОГРНИП ответственного лица оператора ПДн (обязательное поле для ИП)

registered_at
string

Дата регистрации ответственного лица оператора ПДн (обязательное поле для ИП)

Responses

Request samples

Content type
application/json
{
  • "same_as_legal_operator": 0,
  • "order_number": "П-123456",
  • "order_date": "01.01.2000",
  • "inn": "1234567890",
  • "legal_zip": 123456,
  • "legal_city": "Москва",
  • "legal_address": "Ул. Пушкина, д. Колотушкина",
  • "postal_zip": 123456,
  • "postal_city": "Москва",
  • "postal_address": "Ул. Пушкина, д. Колотушкина",
  • "contact_phone": "7123456789",
  • "contact_email": "test@gmail.com",
  • "legal_form": "ИП",
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "birthdate": "01.01.2000",
  • "passport_series": "1234",
  • "passport_number": "567890",
  • "passport_issued_by": "Отделом УФМС России по городу Понивилль",
  • "passport_issued_at": "01.01.2014",
  • "passport_division_code": "123-456",
  • "title": "ИП Иванов Иван Иванович",
  • "ogrnip": "123456789012345",
  • "registered_at": "01.01.2000"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

download template (WIP)

Возвращает word-документ "ПРИКАЗ О НАЗНАЧЕНИИ ОТВЕТСТВЕННОГО ЛИЦА"

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/vnd.openxmlformats-officedocument.wordprocessingml.document

В ответе будет возвращён word-файл

docProps/PK.@j24.docProps/app.xml.#PBwR.{nO&.docProps/core.xml}...............

Цели обработки ПДн

Описание методов для взаимодействия с целями обработки персональных данных.

index

Возвращает список произвольных целей обработки ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "title" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 5 10

Кол-во отображаемых записей на странице.

search
string
Example: search=welcome

Поисковая строка

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт новую произвольную цель обработки ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json

Данные цели обработки ПДн

title
required
string

Цель обработки ПДн

subjects_categories
string

Категории субъектов обработки ПДн

common_categories
string

Общие категории обработки ПДн

special_categories
string

Специальные категории обработки ПДн

legal_basis
string

Правовое основание обработки ПДн

storage_period
string

Срок хранения ПДн

destruction_procedure
string

Порядок уничтожения ПДн

actions
string

Перечень действий

processing_methods
string

Способы обработки

Responses

Request samples

Content type
application/json
{
  • "title": "Ведение административной и бизнес-деятельности, заключение и исполнение договоров на оказание услуг.",
  • "subjects_categories": "Контактные лица (клиенты/пациенты)",
  • "common_categories": "Фамилия, имя, отчество",
  • "special_categories": "Сведения о состоянии здоровья (в объеме, необходимом для заключения договора)",
  • "legal_basis": "Согласие субъекта",
  • "storage_period": "Срок хранения действия договора + 3 года после его окончания (общий срок исковой давности), либо до отзыва согласия/достижения целей обработки, если иное не установлено законодательством.",
  • "destruction_procedure": "Уничтожение (стирание) данных из Программы и уничтожение бумажных носителей (при наличии) путем шредирования в течение 30 дней после истечения срока хранения.",
  • "actions": "сбор; запись; хранение; использование; распространение (предоставление доступа неограниченному кругу лиц); удаление; уничтожение.",
  • "processing_methods": "автоматизированная; с передачей по сети Интернет"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

default

Возвращает список стандартных целей обработки ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные произвольной цели обработки ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataPurposeId
required
integer

Идентификатор цели обработки ПДн

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные произвольной цели обработки ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataPurposeId
required
integer

Идентификатор цели обработки ПДн

Request Body schema: application/json

Данные цели обработки ПДн

title
required
string

Цель обработки ПДн

subjects_categories
string

Категории субъектов обработки ПДн

common_categories
string

Общие категории обработки ПДн

special_categories
string

Специальные категории обработки ПДн

legal_basis
string

Правовое основание обработки ПДн

storage_period
string

Срок хранения ПДн

destruction_procedure
string

Порядок уничтожения ПДн

actions
string

Перечень действий

processing_methods
string

Способы обработки

Responses

Request samples

Content type
application/json
{
  • "title": "Ведение административной и бизнес-деятельности, заключение и исполнение договоров на оказание услуг.",
  • "subjects_categories": "Контактные лица (клиенты/пациенты)",
  • "common_categories": "Фамилия, имя, отчество",
  • "special_categories": "Сведения о состоянии здоровья (в объеме, необходимом для заключения договора)",
  • "legal_basis": "Согласие субъекта",
  • "storage_period": "Срок хранения действия договора + 3 года после его окончания (общий срок исковой давности), либо до отзыва согласия/достижения целей обработки, если иное не установлено законодательством.",
  • "destruction_procedure": "Уничтожение (стирание) данных из Программы и уничтожение бумажных носителей (при наличии) путем шредирования в течение 30 дней после истечения срока хранения.",
  • "actions": "сбор; запись; хранение; использование; распространение (предоставление доступа неограниченному кругу лиц); удаление; уничтожение.",
  • "processing_methods": "автоматизированная; с передачей по сети Интернет"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет произвольную цель обработки ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataPurposeId
required
integer

Идентификатор цели обработки ПДн

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

reset

Сбрасывает список произвольных целей обработки ПДн (удаляет существующие, заменяя их на стандартные).

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": true,
  • "message": "ОК"
}

show settings

Возвращает настройки целей обработки ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update settings

Обновляет настройки целей обработки ПДн.

Требуются права доступа:*

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json

Данные настроек целей ПДн

purposes_target
required
string
Default: "custom"
Enum: "default" "custom"

Цель обработки ПДн

Responses

Request samples

Content type
application/json
{
  • "purposes_target": "custom"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Поручения ПДн

Описание методов для взаимодействия с поручениями персональных данных.

index

Возвращает список поручений ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
query Parameters
page
integer

Номер страницы (для постраничной пагинации).

cursor
string

Курсор (для курсорной пагинации).

sort_by
string
Default: "id"
Enum: "id" "inn" "created_at" "updated_at"

Поле сортировки.

descending
boolean

Флаг обратного направления сортировки.

per_page
integer
Default: 10
Enum: 10 25 50

Кол-во отображаемых записей на странице.

search
string
Example: search=welcome

Произвольный текстовый запрос для поиска записей.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создаёт нового поручения ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json

Данные цели обработки ПДн

start_at
required
string

Дата поручения ПДн

inn
required
string

ИНН поручения ПДн

legal_zip
string

Почтовый индекс города регистрации поручения ПДн

legal_city
required
string

Город регистрации поручения ПДн

legal_address
required
string

Адрес регистрации поручения ПДн

postal_zip
string

Почтовый индекс почтового города поручения ПДн

postal_city
required
string

Почтовый город поручения ПДн

postal_address
required
string

Почтовый адрес поручения ПДн

contact_phone
required
string

Контактный телефон поручения ПДн

contact_email
required
string

Контактный email поручения ПДн

legal_form
required
string

Организационно-правовая форма поручения ПДн

first_name
required
string

Имя. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

last_name
required
string

Фамилия. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

middle_name
required
string

Отчество. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

birthdate
required
string

Дата рождения. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_series
required
string

Серия паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_number
required
string

Номер паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_issued_by
required
string

Кем выдан паспорт. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_issued_at
required
string

Дата выдачи паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_division_code
required
string

Код подразделения паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

title
string

Название поручения ПДн (обязательное поле для ИП и ООО)

ogrnip
string

ОГРНИП поручения ПДн (обязательное поле для ИП)

registered_at
string

Дата регистрации поручения ПДн (обязательное поле для ИП)

ogrn
string

ОГРН поручения ПДн (обязательное поле для ООО)

reason
string

"Действующее на основании" для действующего лица ООО (обязательное поле для ООО)

Responses

Request samples

Content type
application/json
{
  • "start_at": "01.01.2000",
  • "inn": "1234567890",
  • "legal_zip": 123456,
  • "legal_city": "Москва",
  • "legal_address": "Ул. Пушкина, д. Колотушкина",
  • "postal_zip": 123456,
  • "postal_city": "Москва",
  • "postal_address": "Ул. Пушкина, д. Колотушкина",
  • "contact_phone": "7123456789",
  • "contact_email": "test@gmail.com",
  • "legal_form": "ИП",
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "birthdate": "01.01.2000",
  • "passport_series": "1234",
  • "passport_number": "567890",
  • "passport_issued_by": "Отделом УФМС России по городу Понивилль",
  • "passport_issued_at": "01.01.2014",
  • "passport_division_code": "123-456",
  • "title": "ИП Иванов Иван Иванович",
  • "ogrnip": "123456789012345",
  • "registered_at": "01.01.2000",
  • "ogrn": "1234567890123",
  • "reason": "Устава"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные поручения ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataAssignmentId
required
integer

Идентификатор поручения ПДн

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Обновляет данные поручения ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataAssignmentId
required
integer

Идентификатор поручения ПДн

Request Body schema: application/json

Данные цели обработки ПДн

start_at
required
string

Дата поручения ПДн

inn
required
string

ИНН поручения ПДн

legal_zip
string

Почтовый индекс города регистрации поручения ПДн

legal_city
required
string

Город регистрации поручения ПДн

legal_address
required
string

Адрес регистрации поручения ПДн

postal_zip
string

Почтовый индекс почтового города поручения ПДн

postal_city
required
string

Почтовый город поручения ПДн

postal_address
required
string

Почтовый адрес поручения ПДн

contact_phone
required
string

Контактный телефон поручения ПДн

contact_email
required
string

Контактный email поручения ПДн

legal_form
required
string

Организационно-правовая форма поручения ПДн

first_name
required
string

Имя. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

last_name
required
string

Фамилия. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

middle_name
required
string

Отчество. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

birthdate
required
string

Дата рождения. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_series
required
string

Серия паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_number
required
string

Номер паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_issued_by
required
string

Кем выдан паспорт. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_issued_at
required
string

Дата выдачи паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

passport_division_code
required
string

Код подразделения паспорта. Для физлица и ИП — собственные паспортные данные. Для ООО — паспортные данные действующего лица поручения ПДн.

title
string

Название поручения ПДн (обязательное поле для ИП и ООО)

ogrnip
string

ОГРНИП поручения ПДн (обязательное поле для ИП)

registered_at
string

Дата регистрации поручения ПДн (обязательное поле для ИП)

ogrn
string

ОГРН поручения ПДн (обязательное поле для ООО)

reason
string

"Действующее на основании" для действующего лица ООО (обязательное поле для ООО)

Responses

Request samples

Content type
application/json
{
  • "start_at": "01.01.2000",
  • "inn": "1234567890",
  • "legal_zip": 123456,
  • "legal_city": "Москва",
  • "legal_address": "Ул. Пушкина, д. Колотушкина",
  • "postal_zip": 123456,
  • "postal_city": "Москва",
  • "postal_address": "Ул. Пушкина, д. Колотушкина",
  • "contact_phone": "7123456789",
  • "contact_email": "test@gmail.com",
  • "legal_form": "ИП",
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "middle_name": "Иванович",
  • "birthdate": "01.01.2000",
  • "passport_series": "1234",
  • "passport_number": "567890",
  • "passport_issued_by": "Отделом УФМС России по городу Понивилль",
  • "passport_issued_at": "01.01.2014",
  • "passport_division_code": "123-456",
  • "title": "ИП Иванов Иван Иванович",
  • "ogrnip": "123456789012345",
  • "registered_at": "01.01.2000",
  • "ogrn": "1234567890123",
  • "reason": "Устава"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаляет поручения ПДн.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataAssignmentId
required
integer

Идентификатор поручения ПДн

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

download template

Возвращает word-документ "ПОРУЧЕНИЕ НА ОБРАБОТКУ ПЕРСОНАЛЬНЫХ ДАННЫХ И СОГЛАШЕНИЕ О НЕРАЗГЛАШЕНИИ КОНФИДЕНЦИАЛЬНОЙ ИНФОРМАЦИИ (NDA)."

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataAssignmentId
required
integer

Идентификатор поручения ПДн

Responses

Response samples

Content type
application/vnd.openxmlformats-officedocument.wordprocessingml.document

В ответе будет возвращён word-файл

docProps/PK.@j24.docProps/app.xml.#PBwR.{nO&.docProps/core.xml}...............

download template employee dissemination

Возвращает word-документ "Согласие на распространение персональных данных сотрудника"

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataAssignmentId
required
integer

Идентификатор поручения ПДн

Responses

Response samples

Content type
application/vnd.openxmlformats-officedocument.wordprocessingml.document

В ответе будет возвращён word-файл

docProps/PK.@j24.docProps/app.xml.#PBwR.{nO&.docProps/core.xml}...............

download template employee processing

Возвращает word-документ "Согласие на обработку персональных данных сотрудника"

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
path Parameters
personalDataAssignmentId
required
integer

Идентификатор поручения ПДн

Responses

Response samples

Content type
application/vnd.openxmlformats-officedocument.wordprocessingml.document

В ответе будет возвращён word-файл

docProps/PK.@j24.docProps/app.xml.#PBwR.{nO&.docProps/core.xml}...............

Политика конфиденциальности

Описание методов для взаимодействия с политикой конфиденциальности.

show settings

Возвращает настройки политики конфиденциальности.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update settings

Обновляет настройки политики конфиденциальности.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json

Данные настроек политики конфиденциальности

public_url_active
required
boolean

Флаг активности публичной ссылки политики конфиденциальности

show_phone
required
boolean

Флаг необходимости отображения телефона в сгенерированном файле политики конфиденциальности

show_email
required
boolean

Флаг необходимости отображения email в сгенерированном файле политики конфиденциальности

show_legal_address
required
boolean

Флаг необходимости отображения адреса регистрации в сгенерированном файле политики конфиденциальности

show_postal_address
required
boolean

Флаг необходимости отображения почтового адреса в сгенерированном файле политики конфиденциальности

custom_public_url
string

Кастомный URL для политики конфиденциальности.

Responses

Request samples

Content type
application/json
{
  • "public_url_active": false,
  • "show_phone": true,
  • "show_email": true,
  • "show_legal_address": false,
  • "show_postal_address": true,
  • "custom_public_url": "https://mysite.ru/privacy-policy"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

download template

Возвращает стандартный шаблон политики конфиденциальности.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/vnd.openxmlformats-officedocument.wordprocessingml.document

В ответе будет возвращён word-файл

docProps/PK.@j24.docProps/app.xml.#PBwR.{nO&.docProps/core.xml}...............

download custom document

Возвращает кастомный документ политики конфиденциальности.

При отсутствии документа возвращается ошибка с кодом 404.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/vnd.openxmlformats-officedocument.wordprocessingml.document

В ответе будет возвращён word-файл

docProps/PK.@j24.docProps/app.xml.#PBwR.{nO&.docProps/core.xml}...............

upload custom document

Загружает кастомный документ политики конфиденциальности.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken
Request Body schema: multipart/form-data

Файл с политикой конфиденциальности

custom_document
string <binary>

PDF-файл с политикой конфиденциальности (не более 50мб)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy custom document

Удаляет кастомный документ политики конфиденциальности.

Требуются права доступа:

  • TENANT_LEGAL_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Регионы

Описание методов для взаимодействия с регионами.

index

Возвращает список регионов.

Authorizations:
BearerToken
query Parameters
integer

Номер страницы (для постраничной пагинации).

string

Курсор (для курсорной пагинации).

string
Default: "id"
Enum: "id" "code" "name" "created_at" "updated_at"

Поле сортировки.

boolean

Флаг обратного направления сортировки.

integer
Default: 10
Enum: 10 25 50 100

Кол-во отображаемых записей на странице.

string

Произвольный текстовый запрос для поиска записей.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Часовые пояса

Описание методов для взаимодействия с часовыми поясами.

index

Возвращает список доступных часовых поясов.

Требуются права доступа:

  • SYSTEM_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные часового пояса, используемого в системе на данный момент.

Требуются права доступа:

  • SYSTEM_CONFIGURE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Устанавливает часовой пояс, используемый в системе.

Требуются права доступа:

  • SYSTEM_CONFIGURE
Authorizations:
BearerToken
Request Body schema: application/json

Данные часового пояса

name
required
string

Название часового пояса

Responses

Request samples

Content type
application/json
{
  • "name": "Europe/Moscow"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Техническая поддержка

subjects

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

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

send

Отправляет email с данными формы обратной связи.

Authorizations:
BearerToken
Request Body schema: multipart/form-data

Данные формы обратной связи

name
required
string

ФИО пользователя

email
required
string

Email пользователя

subject
required
string

Тема обращения (см. метод получения тем обращений)

content
required
string

Текст обращения

attachments
Array of strings <binary> [ items <binary > ]

Вложения (до 5 файлов, каждый из которых не более 10 мб)

Responses

Request samples

Content type
multipart/form-data
{
  "name": "Иванов Иван Иванович",
  "email": "user@gmail.com",
  "subject": "Сообщение об ошибке",
  "content": "Столкнулся с проблемой на сайте!",
  "attachments": [
    "file.pdf"
  ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "message": "ОК"
}