Перейти к основному содержимому

Evolutrix CRM Rest API | Online registration (1.0.0)

Download OpenAPI specification:Download

Модуль AntCRM - Online registration расширяет возможности Ant CRM, добавляя новый функционал: - Онлайн запись

Настройки

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

index

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

Authorizations:
BearerToken

Responses

Response samples

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

update

Изменение конфигурации онлайн записи

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

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

Данные конфигурации онлайн записи

enabled
required
boolean

Возможность онлайн записи

create_task
required
boolean

Создания клиента, в результате онлайн-записи

create_client
required
boolean

Создания задачи, в результате онлайн-записи

create_lead
required
boolean

Создание обращения, в результате онлайн-записи

multi_services_select
required
boolean

Возможности выбора нескольких позиций услуг из каталога

type_id
required
integer

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

status_id
required
integer

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

deal_status_id
required
integer

Идентификатор статуса сделки (класс DEAL_STATUS)

deal_item_status_id
required
integer

Идентификатор статуса услуги сделки (класс DEAL_ITEM_STATUS)

time_step_slots
integer
Default: 15

Временной шаг окон в минутах

has_signed_up_user
boolean

Сотрудники, к которым записались

user_ids
Array of integers

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

user_role_ids
Array of integers

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

tag_ids
Array of integers

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

object

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

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "create_task": false,
  • "create_client": false,
  • "create_lead": false,
  • "multi_services_select": false,
  • "type_id": 8,
  • "status_id": 3,
  • "deal_status_id": 4,
  • "deal_item_status_id": 5,
  • "time_step_slots": 15,
  • "has_signed_up_user": true,
  • "user_ids": [
    ],
  • "user_role_ids": [
    ],
  • "tag_ids": [
    ],
  • "task": {
    },
  • "lead": {
    }
}

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

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

search
string
Example: search=welcome

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

Responses

Response samples

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

Товары и услуги

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

index

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

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

  • PRODUCT_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","created_at","updated_at"]
Example: sort_by=created_at

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

descending
boolean
Example: descending=true

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

search
string
Example: search=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

Создаёт новый продукт онлайн записи и сохраняет связи с пользователями.

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

  • PRODUCT_SHOW
  • PRODUCT_STORE
Authorizations:
BearerToken
Request Body schema: multipart/form-data
required

Данные продукта онлайн записи

name
required
string <= 255 characters

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

description
required
string

Описание продукта

duration
integer or null [ 1 .. 1440 ]

Продолжительность услуги в минутах

is_show
required
boolean

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

price_mode
required
string
Enum: "manual" "amount_products"

Режим расчёта стоимости (manual — ручной ввод, amount_products — сумма цен выбранных товаров)

price
number

Стоимость продукта (обязательно при price_mode = manual)

discount_mode
required
string
Enum: "none" "percent" "amount"

Тип скидки (none, percent, amount)

discount
number

Значение скидки (процент или сумма, обязателен при отличном от none типе скидки)

product_id
integer

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

user_ids
Array of integers

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

product_ids
Array of integers

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

image
file

Файл с картинкой услуги (не более 50мб)

Responses

Request samples

Content type
multipart/form-data
{
  "name": "Первичный приём косметолога",
  "description": "Онлайн-запись на приём косметолога",
  "duration": 60,
  "is_show": true,
  "price_mode": "manual",
  "price": 2500,
  "discount_mode": "percent",
  "discount": 10,
  "product_id": 15,
  "user_ids": [
    3,
    7,
    11
  ],
  "image": "image.jpeg"
}

Response samples

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

show

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

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

  • PRODUCT_SHOW
Authorizations:
BearerToken
path Parameters
id
required
integer

Идентификатор продукта онлайн записи

Responses

Response samples

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

update

Обновляет данные продукта онлайн записи и связанных пользователей.

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

  • PRODUCT_SHOW
  • PRODUCT_STORE
Authorizations:
BearerToken
path Parameters
id
required
integer

Идентификатор продукта онлайн записи

Request Body schema: multipart/form-data
required

Данные для обновления продукта онлайн записи

name
required
string <= 255 characters

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

description
required
string

Описание продукта

duration
integer or null [ 1 .. 1440 ]

Продолжительность услуги в минутах

is_show
required
boolean

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

price_mode
required
string
Enum: "manual" "amount_products"

Режим расчёта стоимости

price
required
number

Стоимость продукта

discount_mode
required
string
Enum: "none" "percent" "amount"

Тип скидки

discount
required
number

Значение скидки

product_id
integer

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

user_ids
Array of integers

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

product_ids
Array of integers

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

image
file

Файл с картинкой услуги (не более 50мб)

Responses

Request samples

Content type
multipart/form-data
{
  "name": "Первичный приём косметолога",
  "description": "Обновлённое описание услуги для онлайн-записи",
  "duration": 75,
  "is_show": false,
  "price_mode": "manual",
  "price": 2700,
  "discount_mode": "amount",
  "discount": 300,
  "product_id": 15,
  "user_ids": [
    3,
    7,
    11
  ],
  "image": "image.jpeg"
}

Response samples

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

destroy

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

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

  • PRODUCT_SHOW
  • PRODUCT_DESTROY
Authorizations:
BearerToken
path Parameters
id
required
integer

Идентификатор продукта онлайн записи

Responses

Response samples

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

destroyImage

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

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

  • PRODUCT_SHOW
  • PRODUCT_STORE
Authorizations:
BearerToken
path Parameters
id
required
integer

Идентификатор продукта онлайн записи

Responses

Response samples

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

Настройки - Дизайн

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

index

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

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{}

update

Изменение настроек дизайна онлайн записи

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

  • ONLINE_REGISTRATION_CONFIG_STORE
Authorizations:
BearerToken
Request Body schema: multipart/form-data
required

Данные конфигурации дизайна онлайн записи

appearance
required
string
Enum: "image" "icon"

Вариант оформления

image
file

Файл изображения, обложка главного экрана

color
required
string

Цвет кнопок и акцентных иконок

Responses

Request samples

Content type
multipart/form-data
{
  "appearance": "image",
  "image": "background.png",
  "color": "#659859"
}

Response samples

Content type
application/json
{}

destroyImage

Удаляет изображение из настроек дизайна онлайн записи.

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

  • ONLINE_REGISTRATION_CONFIG_STORE
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{}

Публичная страница

Описание методов для взаимодействия с онлайн записи публичных страниц

store

Создаёт запись онлайн-регистрации и возвращает краткие данные созданной записи.

Authorizations:
BearerToken
Request Body schema: application/json
required

Данные для создания записи онлайн-регистрации

start_from
required
string

Начало выбранного слота.

user_id
required
integer

Идентификатор специалиста.

product_ids
Array of integers

Идентификаторы услуг.

group_ids
Array of integers

Идентификаторы групп услуг.

first_name
string or null

Имя клиента

last_name
required
string

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

required
object
comment
string or null

Комментарий к записи

source_slug
string or null

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

Responses

Request samples

Content type
application/json
{
  • "start_from": "2026-04-08T10:00:00",
  • "user_id": 12,
  • "product_ids": [
    ],
  • "group_ids": [
    ],
  • "first_name": "Иван",
  • "last_name": "Иванов",
  • "contact": {
    },
  • "comment": "Позвонить за час до приёма.",
  • "source_slug": "eyJzcmMiOjF9"
}

Response samples

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

cancel

Отменяет запись онлайн-регистрации по action_hash: меняет статус календарного события и создаёт задачу, если это настроено в параметрах отмены.

Authorizations:
BearerToken
Request Body schema: application/json
required

Данные для отмены записи онлайн-регистрации

action_hash
required
string

Хеш действия из ответа создания записи онлайн-регистрации.

Responses

Request samples

Content type
application/json
{
  • "action_hash": "101|c4ca4238a0b923820dcc509a6f75849b"
}

Response samples

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

reschedule

Переносит запись онлайн-регистрации по action_hash: меняет время календарного события и плановую дату завершения связанной сделки.

Authorizations:
BearerToken
Request Body schema: application/json
required

Данные для переноса записи онлайн-регистрации

start_from
required
string

Новое начало выбранного слота в формате d.m.Y H:i.

action_hash
required
string

Хеш действия из ответа создания записи онлайн-регистрации.

Responses

Request samples

Content type
application/json
{
  • "start_from": "20.04.2026 11:30",
  • "action_hash": "101|c4ca4238a0b923820dcc509a6f75849b"
}

Response samples

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

publicConfig

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

Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{}

catalog

Возвращает список продуктов онлайн записи с is_show=true. При передаче user_ids фильтрует продукты по специалистам:

  • для продуктов без вложенных услуг — специалист должен быть напрямую привязан к продукту;
  • для продуктов с вложенными услугами — специалист должен быть привязан ко всем вложенным услугам.
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
Enum: "id" "created_at" "updated_at" "name" "duration" "price"
Example: sort_by=id

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

descending
boolean
Example: descending=true

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

user_ids
Array of integers

Идентификаторы специалистов для фильтрации каталога услуг. Формат запроса: user_ids[]=1&user_ids[]=2

Responses

Response samples

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

catalogShow

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

Authorizations:
BearerToken
path Parameters
id
required
integer

Идентификатор продукта онлайн записи

Responses

Response samples

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

specialists

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

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
Enum: "id" "first_name" "last_name" "middle_name" "gender"
Example: sort_by=id

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

descending
boolean
Example: descending=true

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

search
string
Example: search=Иван

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

group_ids
Array of integers

Идентификаторы групп. Рекомендуемый формат запроса: group_ids[]=1&group_ids[]=2

product_ids
Array of integers

Идентификаторы продуктов. Рекомендуемый формат запроса: product_ids[]=1&product_ids[]=2

Responses

Response samples

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

specialistShow

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

Authorizations:
BearerToken
path Parameters
id
required
integer

Идентификатор специалиста онлайн записи

Responses

Response samples

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

slots

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

Authorizations:
BearerToken
query Parameters
start_from
required
string

Начало периода поиска слотов.

end_to
required
string

Окончание периода поиска слотов.

user_id
required
integer

Идентификатор специалиста.

product_ids
Array of integers

Идентификаторы услуг. Формат запроса: product_ids[]=1&product_ids[]=2

group_ids
Array of integers

Идентификаторы групп услуг. Формат запроса: group_ids[]=1&group_ids[]=2

Responses

Response samples

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