Evolutrix CRM Rest API | Online registration (1.0.0)

Download OpenAPI specification:Download

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

Настройки

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

index

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

Authorizations:

BearerToken

Responses

Response samples

200
400
401

Content type

application/json

{"success": true,
"data": {"enabled": true,
"create_task": false,
"create_client": false,
"create_lead": false,
"multi_services_select": false,
"tags": [{"id": 224,
"title": "Название тега",
"class": "TAG_CLASS",
"position": 24,
"color": "#915935",
"created_at": "2024-01-18T14:41:47.000000Z",
"updated_at": "2024-01-18T14:41:47.000000Z"
}
],
"users": [{"id": 1,
"email": "test@example.com",
"email_verified_at": "2000-01-01T00:00:00.000000Z",
"is_2fa_active": true,
"avatar": "https://tenant1.stage.evolutrix.ru/img/avatars/%D0%98%D0%98",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"gender": 0,
"birthday": "1995-12-30T00:00:00.000000Z",
"is_super_admin": true,
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z",
"deactivated_at": "2024-01-18T14:41:45.000000Z"
}
],
"lead": {"title": "Magnam sit labore quia maxime.",
"description": "Hic aliquid quis provident quam dolorem enim voluptas.",
"lead_at": "2019-12-01T00:00:00.000000Z",
"status": {"id": 1,
"title": "Название статуса",
"class": "STATUS_CLASS",
"position": 1,
"color": "#ef8200",
"icon": "fa-solid fa-status",
"is_system": true,
"created_at": "2024-03-14T09:09:31.000000Z",
"updated_at": "2024-03-14T09:09:31.000000Z"
},
"source_type": {"id": 8,
"title": "Название типа",
"class": "TYPE_CLASS",
"position": 7,
"color": "#4C75A3",
"icon": "fa-brands fa-type-class",
"is_system": false,
"created_at": "2024-01-18T14:41:42.000000Z",
"updated_at": "2024-01-18T14:41:42.000000Z"
},
"users": [{"id": 1,
"email": "test@example.com",
"email_verified_at": "2000-01-01T00:00:00.000000Z",
"is_2fa_active": true,
"avatar": "https://tenant1.stage.evolutrix.ru/img/avatars/%D0%98%D0%98",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"gender": 0,
"birthday": "1995-12-30T00:00:00.000000Z",
"is_super_admin": true,
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z",
"deactivated_at": "2024-01-18T14:41:45.000000Z"
}
],
"tags": [{"id": 224,
"title": "Название тега",
"class": "TAG_CLASS",
"position": 24,
"color": "#915935",
"created_at": "2024-01-18T14:41:47.000000Z",
"updated_at": "2024-01-18T14:41:47.000000Z"
}
],
"user_roles": [{"id": 1,
"title": "Бухгалтер",
"description": "Считает деньги",
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z"
}
],
"which_signed_users": true
},
"task": {"0": true,
"title": "Новая задача",
"description": "Описание задачи",
"result": "Результат выполнения задачи",
"priority": 1,
"status": {"id": 1,
"title": "Название статуса",
"class": "STATUS_CLASS",
"position": 1,
"color": "#ef8200",
"icon": "fa-solid fa-status",
"is_system": true,
"created_at": "2024-03-14T09:09:31.000000Z",
"updated_at": "2024-03-14T09:09:31.000000Z"
},
"type": {"id": 8,
"title": "Название типа",
"class": "TYPE_CLASS",
"position": 7,
"color": "#4C75A3",
"icon": "fa-brands fa-type-class",
"is_system": false,
"created_at": "2024-01-18T14:41:42.000000Z",
"updated_at": "2024-01-18T14:41:42.000000Z"
},
"executors": [{"id": 1,
"email": "test@example.com",
"email_verified_at": "2000-01-01T00:00:00.000000Z",
"is_2fa_active": true,
"avatar": "https://tenant1.stage.evolutrix.ru/img/avatars/%D0%98%D0%98",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"gender": 0,
"birthday": "1995-12-30T00:00:00.000000Z",
"is_super_admin": true,
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z",
"deactivated_at": "2024-01-18T14:41:45.000000Z"
}
],
"tags": [{"id": 224,
"title": "Название тега",
"class": "TAG_CLASS",
"position": 24,
"color": "#915935",
"created_at": "2024-01-18T14:41:47.000000Z",
"updated_at": "2024-01-18T14:41:47.000000Z"
}
],
"participant_roles": [{"id": 1,
"title": "Бухгалтер",
"description": "Считает деньги",
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z"
}
],
"participant_which_signed_users": true
}
},
"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 Возможности выбора нескольких позиций услуг из каталога
user_ids	Array of integers Массив идентификаторов сотрудников (не более 50)
tag_ids	Array of integers Массив идентификаторов меток (не более 50)

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"create_task": false,
"create_client": false,
"create_lead": false,
"multi_services_select": false,
"user_ids": [1
],
"tag_ids": [224
],
"task": {"title": "dfsdfdss",
"description": "dfsdfs",
"result": "sdfdsfds",
"priority": 1,
"type_id": 27,
"status_id": 10,
"tag_ids": [1
],
"executor_user_ids": [1
],
"executor_role_ids": [1
],
"executor_which_signed_users": true,
"participant_user_ids": [1
],
"participant_role_ids": [1
],
"participant_which_signed_users": true
},
"lead": {"title": "Заявка на онлайн-регистрацию",
"description": "Заявка на онлайн-регистрацию на сайте",
"source_type_id": 1,
"status_id": 2,
"which_signed_users": true,
"user_ids": [2
],
"user_role_ids": [1
],
"tag_ids": [1
]
}
}

Response samples

200
400
401
403

Content type

application/json

{"success": true,
"data": {"enabled": true,
"create_task": false,
"create_client": false,
"create_lead": false,
"multi_services_select": false,
"tags": [{"id": 224,
"title": "Название тега",
"class": "TAG_CLASS",
"position": 24,
"color": "#915935",
"created_at": "2024-01-18T14:41:47.000000Z",
"updated_at": "2024-01-18T14:41:47.000000Z"
}
],
"users": [{"id": 1,
"email": "test@example.com",
"email_verified_at": "2000-01-01T00:00:00.000000Z",
"is_2fa_active": true,
"avatar": "https://tenant1.stage.evolutrix.ru/img/avatars/%D0%98%D0%98",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"gender": 0,
"birthday": "1995-12-30T00:00:00.000000Z",
"is_super_admin": true,
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z",
"deactivated_at": "2024-01-18T14:41:45.000000Z"
}
],
"lead": {"title": "Magnam sit labore quia maxime.",
"description": "Hic aliquid quis provident quam dolorem enim voluptas.",
"lead_at": "2019-12-01T00:00:00.000000Z",
"status": {"id": 1,
"title": "Название статуса",
"class": "STATUS_CLASS",
"position": 1,
"color": "#ef8200",
"icon": "fa-solid fa-status",
"is_system": true,
"created_at": "2024-03-14T09:09:31.000000Z",
"updated_at": "2024-03-14T09:09:31.000000Z"
},
"source_type": {"id": 8,
"title": "Название типа",
"class": "TYPE_CLASS",
"position": 7,
"color": "#4C75A3",
"icon": "fa-brands fa-type-class",
"is_system": false,
"created_at": "2024-01-18T14:41:42.000000Z",
"updated_at": "2024-01-18T14:41:42.000000Z"
},
"users": [{"id": 1,
"email": "test@example.com",
"email_verified_at": "2000-01-01T00:00:00.000000Z",
"is_2fa_active": true,
"avatar": "https://tenant1.stage.evolutrix.ru/img/avatars/%D0%98%D0%98",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"gender": 0,
"birthday": "1995-12-30T00:00:00.000000Z",
"is_super_admin": true,
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z",
"deactivated_at": "2024-01-18T14:41:45.000000Z"
}
],
"tags": [{"id": 224,
"title": "Название тега",
"class": "TAG_CLASS",
"position": 24,
"color": "#915935",
"created_at": "2024-01-18T14:41:47.000000Z",
"updated_at": "2024-01-18T14:41:47.000000Z"
}
],
"user_roles": [{"id": 1,
"title": "Бухгалтер",
"description": "Считает деньги",
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z"
}
],
"which_signed_users": true
},
"task": {"0": true,
"title": "Новая задача",
"description": "Описание задачи",
"result": "Результат выполнения задачи",
"priority": 1,
"status": {"id": 1,
"title": "Название статуса",
"class": "STATUS_CLASS",
"position": 1,
"color": "#ef8200",
"icon": "fa-solid fa-status",
"is_system": true,
"created_at": "2024-03-14T09:09:31.000000Z",
"updated_at": "2024-03-14T09:09:31.000000Z"
},
"type": {"id": 8,
"title": "Название типа",
"class": "TYPE_CLASS",
"position": 7,
"color": "#4C75A3",
"icon": "fa-brands fa-type-class",
"is_system": false,
"created_at": "2024-01-18T14:41:42.000000Z",
"updated_at": "2024-01-18T14:41:42.000000Z"
},
"executors": [{"id": 1,
"email": "test@example.com",
"email_verified_at": "2000-01-01T00:00:00.000000Z",
"is_2fa_active": true,
"avatar": "https://tenant1.stage.evolutrix.ru/img/avatars/%D0%98%D0%98",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"gender": 0,
"birthday": "1995-12-30T00:00:00.000000Z",
"is_super_admin": true,
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z",
"deactivated_at": "2024-01-18T14:41:45.000000Z"
}
],
"tags": [{"id": 224,
"title": "Название тега",
"class": "TAG_CLASS",
"position": 24,
"color": "#915935",
"created_at": "2024-01-18T14:41:47.000000Z",
"updated_at": "2024-01-18T14:41:47.000000Z"
}
],
"participant_roles": [{"id": 1,
"title": "Бухгалтер",
"description": "Считает деньги",
"created_at": "2024-01-18T14:41:45.000000Z",
"updated_at": "2024-01-18T14:41:45.000000Z"
}
],
"participant_which_signed_users": true
}
},
"message": "ОК"
}

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

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

index

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

Authorizations:

BearerToken

Responses

Response samples

200
400
401

Content type

application/json

{"success": true,
"data": {"image": "https://tenant1.stage.evolutrix.ru/img/background.png",
"appearance": "image",
"color": "#659859"
},
"message": "ОК"
}

update

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

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

ONLINE_REGISTRATION_CONFIG_STORE

Authorizations:

BearerToken

Request Body schema: multipart/form-data

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

appearance required	string Enum: "image" "icon" Вариант оформления
image	string URL изображения, обложка главного экрана
color required	string Цвет кнопок и акцентных иконок

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "appearance": "image",
  "image": "background.png",
  "color": "#659859"
}

Response samples

200
400
401
403

Content type

application/json

{"success": true,
"data": {"image": "https://tenant1.stage.evolutrix.ru/img/background.png",
"appearance": "image",
"color": "#659859"
},
"message": "ОК"
}

Источники

index

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

Authorizations:

BearerToken

Responses

Response samples

200
400
401

Content type

application/json

Example

Постраничная пагинация

{"success": true,
"data": {"online_registration_sources": [{"id": 8,
"title": "Название типа",
"class": "TYPE_CLASS",
"position": 7,
"color": "#4C75A3",
"icon": "fa-brands fa-type-class",
"is_system": false,
"created_at": "2024-01-18T14:41:42.000000Z",
"updated_at": "2024-01-18T14:41:42.000000Z",
"url": "https://mysite.ru/ant-online-registration/?q=SDFew"
}
],
"meta": {"current_page": 3,
"from": 1,
"last_page": 5,
"links": [{"label": "&laquo; Назад",
"active": false
},
{"url": "/resource?per_page=10&page=2",
"label": "2",
"active": false
},
{"url": "/resource?per_page=10&page=3",
"label": "3",
"active": false
},
{"url": "/resource?per_page=10&page=2",
"label": "Вперёд &raquo;",
"active": false
}
],
"path": "/resource/resource",
"per_page": 15,
"to": 15,
"total": 75
},
"links": {"first": "/resource?per_page=10&page=1",
"last": "/resource?per_page=10&page=10",
"next": "/resource?per_page=10&page=2"
}
},
"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 идентификаторов в одном запросе.
group_id	integer Идентификатор группы товаров и услуг

Responses

Response samples

200
400
401
403

Content type

application/json

Example

Постраничная пагинация

{"success": true,
"data": {"online_registration_products": [{"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
}
],
"meta": {"current_page": 3,
"from": 1,
"last_page": 5,
"links": [{"label": "&laquo; Назад",
"active": false
},
{"url": "/api/v1.0.0/ant-online-registration/products?per_page=10&page=2",
"label": "2",
"active": false
},
{"url": "/api/v1.0.0/ant-online-registration/products?per_page=10&page=3",
"label": "3",
"active": false
},
{"url": "/api/v1.0.0/ant-online-registration/products?per_page=10&page=2",
"label": "Вперёд &raquo;",
"active": false
}
],
"path": "/api/v1.0.0/ant-online-registration/products/resource",
"per_page": 15,
"to": 15,
"total": 75
},
"links": {"first": "/api/v1.0.0/ant-online-registration/products?per_page=10&page=1",
"last": "/api/v1.0.0/ant-online-registration/products?per_page=10&page=10",
"next": "/api/v1.0.0/ant-online-registration/products?per_page=10&page=2"
}
},
"message": "ОК"
}

store

Создаёт новый продукт онлайн записи.

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

PRODUCT_SHOW
PRODUCT_STORE

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

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

name required	string <= 255 characters Название продукта онлайн записи
description required	string Описание продукта
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 required	integer Идентификатор связанного товара из модуля Commerce
image	file Файл с картинкой услуги (не более 50мб)

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Первичный приём косметолога",
  "description": "Онлайн-запись на приём косметолога",
  "is_show": true,
  "price_mode": "manual",
  "price": 2500,
  "discount_mode": "percent",
  "discount": 10,
  "product_id": 15,
  "image": "image.jpeg"
}

Response samples

200
400
401
403

Content type

application/json

{"success": true,
"data": {"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
},
"message": "ОК"
}

show

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

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

PRODUCT_SHOW

Authorizations:

BearerToken

path Parameters

id

required

integer

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

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
},
"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 Описание продукта
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 required	integer Идентификатор связанного товара из модуля Commerce
image	file Файл с картинкой услуги (не более 50мб)

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Первичный приём косметолога",
  "description": "Обновлённое описание услуги для онлайн-записи",
  "is_show": false,
  "price_mode": "manual",
  "price": 2700,
  "discount_mode": "amount",
  "discount": 300,
  "product_id": 15,
  "image": "image.jpeg"
}

Response samples

200
400
401
403
404

Content type

application/json

{"success": true,
"data": {"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
},
"message": "ОК"
}

destroy

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

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

PRODUCT_SHOW
PRODUCT_DESTROY

Authorizations:

BearerToken

path Parameters

id

required

integer

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

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
},
"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

200
400
401
403

Content type

application/json

Example

Постраничная пагинация

{"success": true,
"data": {"online_registration_groups": [{"id": 41,
"created_at": "2024-03-02T09:00:00",
"updated_at": "2024-03-05T14:15:00",
"name": "Пакет \"Абонемент\"",
"description": "Набор услуг №1",
"is_show": true,
"price_mode": "manual",
"price": 9000,
"discount_mode": "percent",
"discount": 5,
"image_url": "https://tenant1.stage.evolutrix.ru/storage/online-registration/groups/41.png",
"products": [{"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
}
],
"price_list": {"id": 1,
"title": "Новый прайс-лист",
"description": "Описание нового прайс-листа",
"stamp_with_details_file": "http://ant-crm.local/storage/price_lists_files/DmJPvPbfE7kTGLPdkNsHIruF8HylBsED8mH0PHqh.png",
"stamp_confirmation_file": "http://ant-crm.local/storage/price_lists_files/XxYF5B05voHjuicpDzO1eeY2AwgAmsTVRLoUfyDa.png",
"created_at": "2024-09-26T09:04:10.000000Z",
"updated_at": "2024-09-27T07:47:58.000000Z"
}
}
],
"meta": {"current_page": 3,
"from": 1,
"last_page": 5,
"links": [{"label": "&laquo; Назад",
"active": false
},
{"url": "/api/v1.0.0/ant-online-registration/groups?per_page=10&page=2",
"label": "2",
"active": false
},
{"url": "/api/v1.0.0/ant-online-registration/groups?per_page=10&page=3",
"label": "3",
"active": false
},
{"url": "/api/v1.0.0/ant-online-registration/groups?per_page=10&page=2",
"label": "Вперёд &raquo;",
"active": false
}
],
"path": "/api/v1.0.0/ant-online-registration/groups/resource",
"per_page": 15,
"to": 15,
"total": 75
},
"links": {"first": "/api/v1.0.0/ant-online-registration/groups?per_page=10&page=1",
"last": "/api/v1.0.0/ant-online-registration/groups?per_page=10&page=10",
"next": "/api/v1.0.0/ant-online-registration/groups?per_page=10&page=2"
}
},
"message": "ОК"
}

store

Создаёт новую группу онлайн записи.

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

PRODUCT_SHOW
PRODUCT_STORE

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

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

name required	string <= 255 characters Название группы онлайн записи
description required	string Описание группы
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_ids required	Array of integers Массив идентификаторов продуктов, входящих в группу
price_list_id required	integer Идентификатор прайс-листа из модуля Commerce
image	file Файл изображения (JPEG/PNG до 50 МБ)

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Пакет \"Абонемент\"",
  "description": "Набор услуг со скидкой",
  "is_show": true,
  "price_mode": "manual",
  "price": 9000,
  "discount_mode": "percent",
  "discount": 5,
  "product_ids": [
    10,
    14,
    18
  ],
  "price_list_id": 7,
  "image": "image.jpeg"
}

Response samples

200
400
401
403

Content type

application/json

{"success": true,
"data": {"id": 41,
"created_at": "2024-03-02T09:00:00",
"updated_at": "2024-03-05T14:15:00",
"name": "Пакет \"Абонемент\"",
"description": "Набор услуг №1",
"is_show": true,
"price_mode": "manual",
"price": 9000,
"discount_mode": "percent",
"discount": 5,
"image_url": "https://tenant1.stage.evolutrix.ru/storage/online-registration/groups/41.png",
"products": [{"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
}
],
"price_list": {"id": 1,
"title": "Новый прайс-лист",
"description": "Описание нового прайс-листа",
"stamp_with_details_file": "http://ant-crm.local/storage/price_lists_files/DmJPvPbfE7kTGLPdkNsHIruF8HylBsED8mH0PHqh.png",
"stamp_confirmation_file": "http://ant-crm.local/storage/price_lists_files/XxYF5B05voHjuicpDzO1eeY2AwgAmsTVRLoUfyDa.png",
"created_at": "2024-09-26T09:04:10.000000Z",
"updated_at": "2024-09-27T07:47:58.000000Z"
}
},
"message": "ОК"
}

show

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

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

PRODUCT_SHOW

Authorizations:

BearerToken

path Parameters

id

required

integer

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

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"id": 41,
"created_at": "2024-03-02T09:00:00",
"updated_at": "2024-03-05T14:15:00",
"name": "Пакет \"Абонемент\"",
"description": "Набор услуг №1",
"is_show": true,
"price_mode": "manual",
"price": 9000,
"discount_mode": "percent",
"discount": 5,
"image_url": "https://tenant1.stage.evolutrix.ru/storage/online-registration/groups/41.png",
"products": [{"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
}
],
"price_list": {"id": 1,
"title": "Новый прайс-лист",
"description": "Описание нового прайс-листа",
"stamp_with_details_file": "http://ant-crm.local/storage/price_lists_files/DmJPvPbfE7kTGLPdkNsHIruF8HylBsED8mH0PHqh.png",
"stamp_confirmation_file": "http://ant-crm.local/storage/price_lists_files/XxYF5B05voHjuicpDzO1eeY2AwgAmsTVRLoUfyDa.png",
"created_at": "2024-09-26T09:04:10.000000Z",
"updated_at": "2024-09-27T07:47:58.000000Z"
}
},
"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 Описание группы
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_ids required	Array of integers Массив идентификаторов продуктов, входящих в группу
price_list_id required	integer Идентификатор прайс-листа из модуля Commerce
image	file Файл изображения (JPEG/PNG до 50 МБ)

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Пакет \"Абонемент\"",
  "description": "Обновлённое описание набора услуг",
  "is_show": false,
  "price_mode": "manual",
  "price": 9500,
  "discount_mode": "amount",
  "discount": 1000,
  "product_ids": [
    10,
    14,
    20
  ],
  "price_list_id": 7,
  "image": "image.jpeg"
}

Response samples

200
400
401
403
404

Content type

application/json

{"success": true,
"data": {"id": 41,
"created_at": "2024-03-02T09:00:00",
"updated_at": "2024-03-05T14:15:00",
"name": "Пакет \"Абонемент\"",
"description": "Набор услуг №1",
"is_show": true,
"price_mode": "manual",
"price": 9000,
"discount_mode": "percent",
"discount": 5,
"image_url": "https://tenant1.stage.evolutrix.ru/storage/online-registration/groups/41.png",
"products": [{"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
}
],
"price_list": {"id": 1,
"title": "Новый прайс-лист",
"description": "Описание нового прайс-листа",
"stamp_with_details_file": "http://ant-crm.local/storage/price_lists_files/DmJPvPbfE7kTGLPdkNsHIruF8HylBsED8mH0PHqh.png",
"stamp_confirmation_file": "http://ant-crm.local/storage/price_lists_files/XxYF5B05voHjuicpDzO1eeY2AwgAmsTVRLoUfyDa.png",
"created_at": "2024-09-26T09:04:10.000000Z",
"updated_at": "2024-09-27T07:47:58.000000Z"
}
},
"message": "ОК"
}

destroy

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

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

PRODUCT_SHOW
PRODUCT_DESTROY

Authorizations:

BearerToken

path Parameters

id

required

integer

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

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"id": 41,
"created_at": "2024-03-02T09:00:00",
"updated_at": "2024-03-05T14:15:00",
"name": "Пакет \"Абонемент\"",
"description": "Набор услуг №1",
"is_show": true,
"price_mode": "manual",
"price": 9000,
"discount_mode": "percent",
"discount": 5,
"image_url": "https://tenant1.stage.evolutrix.ru/storage/online-registration/groups/41.png",
"products": [{"id": 101,
"created_at": "2024-03-01T12:00:00",
"updated_at": "2024-03-05T09:30:00",
"name": "Первичный приём косметолога",
"description": "Услуга онлайн-записи для приёма косметолога",
"is_show": true,
"price_mode": "manual",
"price": 2500,
"discount_mode": "percent",
"discount": 10,
"image": "https://tenant1.stage.evolutrix.ru/path-to-file.png"
}
],
"price_list": {"id": 1,
"title": "Новый прайс-лист",
"description": "Описание нового прайс-листа",
"stamp_with_details_file": "http://ant-crm.local/storage/price_lists_files/DmJPvPbfE7kTGLPdkNsHIruF8HylBsED8mH0PHqh.png",
"stamp_confirmation_file": "http://ant-crm.local/storage/price_lists_files/XxYF5B05voHjuicpDzO1eeY2AwgAmsTVRLoUfyDa.png",
"created_at": "2024-09-26T09:04:10.000000Z",
"updated_at": "2024-09-27T07:47:58.000000Z"
}
},
"message": "ОК"
}

Evolutrix CRM Rest API | Online registration (1.0.0)

Настройки

index

Authorizations:

Responses

Response samples

update

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

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

index

Authorizations:

Responses

Response samples

update

Authorizations:

Request Body schema: multipart/form-data

Responses

Request samples

Response samples

Источники

index

Authorizations:

Responses

Response samples

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

index

Authorizations:

query Parameters

Responses

Response samples

store

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Request samples

Response samples

show

Authorizations:

path Parameters

Responses

Response samples

update

Authorizations:

path Parameters

Request Body schema: multipart/form-datarequired

Responses

Request samples

Response samples

destroy

Authorizations:

path Parameters

Responses

Response samples

Группы товаров и услуг

index

Authorizations:

query Parameters

Responses

Response samples

store

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Request samples

Response samples

show

Authorizations:

path Parameters

Responses

Response samples

update

Authorizations:

path Parameters

Request Body schema: multipart/form-datarequired

Responses

Request samples

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required