Модуль веб-сервиса с безопасностью и фильтрацией, работает через веб-сервер ДатаЭкспресс.
REST API для работы с базами данных DataExpress через HTTP. Работает через встроенный веб-сервер dxwebsrv.
Версия: 10
Базовый URL: http://127.0.0.1/test_api/ (для примера из демо)
настройка веб-сервера
[test_api]
Database=DEMO_DB_WEB_API.FDB
Templates=templates
SessionTime=30
ServiceId=73a90acaae2b1ccc0e96970966
Базовые параметры
serviceid (обязательный) — идентификатор сервиса из dxwebsrv.cfg
apikey (обязательный) — секретный ключ доступа
form (обязательный для большинства методов) — имя формы DataExpress
method — только для SQL-методов (SQLSelect, SQLExecute)
Методы API
1. GET — Получение данных
Параметры:
id — ID конкретной записи
filter — фильтр в синтаксисе DataExpress
expand — lookups, tables, queries, all, 1, true
Примеры:
Получить все записи:
http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
Получить запись по ID:
http://127.0.0.1/test_api/?serviceid=.. ... =api&id=21
Получить с фильтром:
http://127.0.0.1/test_api/?serviceid=.. ... pi&filter=[Флажок]=='1'
Получить с раскрытием lookup:
http://127.0.0.1/test_api/?serviceid=.. ... nd=lookups
Получить с подчинёнными таблицами и запросами:
http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&expand=all,lookups
2. POST — Создание записи
Тело запроса: JSON с парами "Имя поля": "Значение".
Особенности:
Lookup-поля: ID ("Объект": "9") или объект для создания ("Объект": {"Название": "Новая"})
Ключ _tables — массовое создание подчинённых записей
Файлы — через Base64 (data:...;base64,...)
Примеры:
Создать простую запись:
POST http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
{
"key": "Тест",
"Число": "42",
"Дата": "05.11.2026",
"Флажок": "1"
}
Создать с подчинёнными таблицами:
POST http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара
{
"Номер": "100",
"Дата": "05.11.2026",
"Клиент": "3",
"_tables": {
"Проданный товар": [
{"Товар": "1", "Количество": "2", "Закупка": "2300"},
{"Товар": "2", "Количество": "5", "Закупка": "36"}
]
}
}
Загрузить файл:
POST http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
{
"key": "Документ",
"Файл": "data:application/pdf;base64,JVBERi0xLjQK..."
}
3. PUT — Полная замена записи
Параметры: id (в URL или теле JSON)
Особенности:
Все непереданные поля сбрасываются в null
Если _tables не передан — удаляются ВСЕ подчинённые записи
Если _tables передан — старые подчинённые записи удаляются, создаются новые
Примеры:
Полная замена родителя:
PUT http://127.0.0.1/test_api/?serviceid=.. ... m=api&id=1
{
"key": "Полная замена",
"Число": "100",
"Дата": "05.11.2026",
"Флажок": "1"
}
Полная замена с очисткой подчинённых таблиц:
PUT http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"Номер": "4",
"Дата": "23.03.2021",
"Клиент": "3"
}
4. PATCH — Частичное обновление
Параметры: id (в URL или теле JSON)
Особенности:
Обновляются только переданные поля, остальные сохраняются
Если _tables не передан — подчинённые записи не трогаются
Если _tables передан — добавляются новые или обновляются существующие по id
Примеры:
Обновление только одного поля:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... m=api&id=1
{
"key": "Обновлено через PATCH"
}
Добавление подчинённой записи:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"_tables": {
"Проданный товар": [
{"Товар": "3", "Количество": "10", "Закупка": "17"}
]
}
}
Обновление существующей подчинённой записи:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"_tables": {
"Проданный товар": [
{"id": "49", "Количество": "3", "Закупка": "3300"}
]
}
}
5. DELETE — Удаление записи
Параметры: id (обязательно)
Пример:
DELETE http://127.0.0.1/test_api/?serviceid=.. ... api&id=111
Ответ:
{"code": 200, "id": "111"}
6. SQLSelect — Выполнение SELECT-запроса
Параметры: method=SQLSelect
Тело: JSON с полем "sql"
Пример:
POST http://127.0.0.1/test_api/?serviceid=.. ... =SQLSelect
{
"sql": "SELECT * FROM [Товары] WHERE [Группа] = 'Электроника'"
}
7. SQLExecute — Выполнение произвольного SQL
Параметры: method=SQLExecute
Тело: JSON с полем "sql"
Пример:
POST http://127.0.0.1/test_api/?serviceid=.. ... SQLExecute
{
"sql": "UPDATE t7 SET f28 = 'Мука' WHERE f28 = 'новое название'"
}
Загрузка файлов через Base64
Формат: data:[<mime-type>][;base64],<данные>
Поддерживаемые MIME-типы:
PNG (image/png) → .png
JPEG (image/jpeg) → .jpg
GIF (image/gif) → .gif
PDF (application/pdf) → .pdf
TXT (text/plain) → .txt
Word (application/vnd.openxmlformats...wordprocessingml...) → .docx
Excel (application/vnd.openxmlformats...spreadsheetml...) → .xlsx
Пример:
{
"Файл": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MK..."
}
Работа с подчинёнными таблицами (ключ _tables)
Структура:
{
"_tables": {
"Имя подчинённой формы": [
{"поле1": "значение1", "поле2": "значение2"},
{"id": "123", "поле1": "новое значение"}
]
}
}
Правила:
Нет id → создаётся новая запись (Append)
Есть id → открывается существующая запись на редактирование
PUT → полная замена (старые удаляются)
PATCH → добавление/обновление (старые сохраняются)
Коды ответов
0 — успешный GET
200 — успешные POST/PUT/PATCH/DELETE/SQL
400 — ошибка валидации, некорректный JSON
403 — отказано в доступе (неверный API-ключ)
404 — запись или форма не найдена
500 — внутренняя ошибка сервера
Важные особенности
Имена полей vs имена компонентов — в JSON всегда используйте имена полей (Объект), а не компонентов (dxLookupComboBox1).
Форматы дат/времени — даты: ДД.ММ.ГГГГ, время: ЧЧ:ММ:СС.
Вычисляемые поля — поля с Expression игнорируют попытки записи.
Обязательные поля — при создании записи через POST/PUT передавайте все обязательные поля; при обновлении через PATCH можно передавать только изменяемые.
Временные файлы — папка uploads используется только как буфер, после загрузки в BLOB временные файлы удаляются автоматически.
версия 8.3.
версия 8.8.
версия 9.0
1) Для поля объекта добавил поиск по переданному тексту для POST, PUT, PATCH, также по переданному тексту добавляется новая запись формы объекта, если не нашел подходящую, но пользоваться надо с осторожностью. Работает в том числе в вложенных таблицах.
2) Добавил передачу файлов/изображений во вложенные таблицы
Версия 10.0
- expand=files (или all): возврат файлов в GET в виде Base64 или URL (настраивается через files_url в apikey)
- Лимит размера загружаемых файлов (поле MaxFileSize в apikey, в МБ)
- Пейджинг для GET: параметры limit (дефолт 100, макс 1000) и offset
- GET с id=0: возврат JSON-шаблона формы для POST
Дополнительные поля в форме apikey:
- files_url (флажок): 1 = URL, 0 = Base64 (для URL файлы помещаются в папку HTML веб-сервера, и отдаются штатными средствами веб-сервера, но это значит, что файлы доступны всем!!!)
- MaxFileSize (число): лимит в МБ (0 или пусто = файлы не принимаются)
Версия 10.7 (устранены замечания DEepSeek по безопасности и производительности):
- БЕЗОПАСНОСТЬ: Безопасный поиск компонентов через try..except во всех местах.
- ИСПРАВЛЕНИЕ URL: ExtractBlobToHtml возвращает абсолютный путь '/html/files/...'.
- BASE64: Использование встроенных DecodeBase64/EncodeBase64 для корректной работы
с бинарными данными (решает проблему Unicode-повреждений). BASE64: Strict=False для корректной обработки unpadded base64. BASE64: Валидация base64 символов до декодирования.
- Строгая валидация полей. Теперь сервер возвращает ошибку 400 с детальным массивом errors, где указано, какое именно поле не найдено.
- При ошибках загрузки файлов запись не сохраняется.
- Попытки загрузить файлы через пути с .. или : (например, ..\..\Windows\win.ini) теперь блокируются на уровне сервера.
- Изменение поведения expand=all. Ранее параметр expand=all раскрывал таблицы, запросы и файлы, но не включал раскрытие lookup-полей. Теперь expand=all раскрывает всё, включая lookup. Для обратной совместимости можно использовать expand=tables,queries,files без lookups.
- Пейджинг: Дефолтный limit теперь равен 100 (ранее был неограничен). Максимальный limit ограничен 1000 (ранее не ограничивался). Если клиент не указал limit, сервер вернёт в ответе поле "limit": 100.
- При использовании ключа с files_url=1 сервер теперь возвращает абсолютный путь /html/files/... вместо относительного html/files/...
- POST с пустым телом или только _tables (без полей родителя) теперь возвращает 400 вместо 500.
- PUT с одним полем возвращает корректный JSON. Ранее в ответе мог появиться невалидный JSON вида {"updated": {, "field":"value".
- Все SQL-запросы к таблице apikey используют экранирование кавычек для защиты от инъекций.
- Устранены N+1 запросы при раскрытии _queries в GET-запросах. Структура запросов теперь кэшируется до начала обработки записей.
- Все control-символы (#0..#31) в текстовых полях теперь корректно экранируются в JSON-ответах.
- Ошибки в дочерних таблицах (невалидные файлы, lookup, типы данных) теперь возвращаются клиенту в виде детального массива errors с указанием таблицы, ID записи и поля.
Никаких изменений в базе данных делать не нужно. Все существующие ключи продолжат работать.
Универсальный модуль HTTP сервера для API
Модератор: Разработчики расширений
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
- Вложения
-
- HTTP API Server.zip
- (7.44 КБ) 104 скачивания
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
8. PATCH
Обновляет записи частично, переданные данные сохраняет, а не переданные сохраняют старые значения
http://127.0.0.1/test_api/?serviceid=73 ... 3&form=api
"id": "66",
"key": "Новое значение66",
"Число": "3,33",
"Дата": "28.09.2026",
"Время": "15:31"
id можно прописать в теле запроса или указать в параметрах
http://127.0.0.1/test_api/?serviceid=73 ... =api&id=67
"key": "Новое значение66",
"Число": "3,33",
"Дата": "28.09.2026",
"Время": "15:31"
Добавлена проверка на обязательность заполнения полей.
9. PUT
Обновляет запись, но если какие-то поля не переданы, то они сбрасываются на null, id можно прописать в теле запроса или указать в параметрах
http://127.0.0.1/test_api/?serviceid=73 ... =api&id=66
"key": "12dfgdfdfgdf",
"Число": "1.33565",
"Дата": "12.08.2025",
"Время": "",
"Флажок": "0",
"Объект": "9"
Добавлена проверка на обязательность заполнения полей.
Обновляет записи частично, переданные данные сохраняет, а не переданные сохраняют старые значения
http://127.0.0.1/test_api/?serviceid=73 ... 3&form=api
"id": "66",
"key": "Новое значение66",
"Число": "3,33",
"Дата": "28.09.2026",
"Время": "15:31"
id можно прописать в теле запроса или указать в параметрах
http://127.0.0.1/test_api/?serviceid=73 ... =api&id=67
"key": "Новое значение66",
"Число": "3,33",
"Дата": "28.09.2026",
"Время": "15:31"
Добавлена проверка на обязательность заполнения полей.
9. PUT
Обновляет запись, но если какие-то поля не переданы, то они сбрасываются на null, id можно прописать в теле запроса или указать в параметрах
http://127.0.0.1/test_api/?serviceid=73 ... =api&id=66
"key": "12dfgdfdfgdf",
"Число": "1.33565",
"Дата": "12.08.2025",
"Время": "",
"Флажок": "0",
"Объект": "9"
Добавлена проверка на обязательность заполнения полей.
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
Читать данные с запросов не получится
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
Добавлены
1. GET с вложением подчинённых таблиц (expand=tables) и запросов (expand=queries или all), включая раскрытие lookup внутри подчинённых таблиц.
2. Загрузка файлов и изображений (Base64) в POST/PUT/PATCH с сохранением во временную папку uploads, загрузкой в BLOB-поле компонента и мгновенным удалением временного файла.
1. GET с вложением подчинённых таблиц (expand=tables) и запросов (expand=queries или all), включая раскрытие lookup внутри подчинённых таблиц.
2. Загрузка файлов и изображений (Base64) в POST/PUT/PATCH с сохранением во временную папку uploads, загрузкой в BLOB-поле компонента и мгновенным удалением временного файла.
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
Версия 8.8. Обновлены методы api
Методы API
1. GET — Получение данных
Параметры:
id — ID конкретной записи
filter — фильтр в синтаксисе DataExpress
expand — lookups, tables, queries, all, 1, true
Примеры:
Получить все записи:
http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
Получить запись по ID:
http://127.0.0.1/test_api/?serviceid=.. ... =api&id=21
Получить с фильтром:
http://127.0.0.1/test_api/?serviceid=.. ... pi&filter=[Флажок]=='1'
Получить с раскрытием lookup:
http://127.0.0.1/test_api/?serviceid=.. ... nd=lookups
Получить с подчинёнными таблицами и запросами:
http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&expand=all,lookups
2. POST — Создание записи
Тело запроса: JSON с парами "Имя поля": "Значение".
Особенности:
Lookup-поля: ID ("Объект": "9") или объект для создания ("Объект": {"Название": "Новая"})
Ключ _tables — массовое создание подчинённых записей
Файлы — через Base64 (data:...;base64,...)
Примеры:
Создать простую запись:
POST http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
{
"key": "Тест",
"Число": "42",
"Дата": "05.11.2026",
"Флажок": "1"
}
Создать с подчинёнными таблицами:
POST http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара
{
"Номер": "100",
"Дата": "05.11.2026",
"Клиент": "3",
"_tables": {
"Проданный товар": [
{"Товар": "1", "Количество": "2", "Закупка": "2300"},
{"Товар": "2", "Количество": "5", "Закупка": "36"}
]
}
}
Загрузить файл:
POST http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
{
"key": "Документ",
"Файл": "data:application/pdf;base64,JVBERi0xLjQK..."
}
3. PUT — Полная замена записи
Параметры: id (в URL или теле JSON)
Особенности:
Все непереданные поля сбрасываются в null
Если _tables не передан — удаляются ВСЕ подчинённые записи
Если _tables передан — старые подчинённые записи удаляются, создаются новые
Примеры:
Полная замена родителя:
PUT http://127.0.0.1/test_api/?serviceid=.. ... m=api&id=1
{
"key": "Полная замена",
"Число": "100",
"Дата": "05.11.2026",
"Флажок": "1"
}
Полная замена с очисткой подчинённых таблиц:
PUT http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"Номер": "4",
"Дата": "23.03.2021",
"Клиент": "3"
}
4. PATCH — Частичное обновление
Параметры: id (в URL или теле JSON)
Особенности:
Обновляются только переданные поля, остальные сохраняются
Если _tables не передан — подчинённые записи не трогаются
Если _tables передан — добавляются новые или обновляются существующие по id
Примеры:
Обновление только одного поля:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... m=api&id=1
{
"key": "Обновлено через PATCH"
}
Добавление подчинённой записи:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"_tables": {
"Проданный товар": [
{"Товар": "3", "Количество": "10", "Закупка": "17"}
]
}
}
Обновление существующей подчинённой записи:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"_tables": {
"Проданный товар": [
{"id": "49", "Количество": "3", "Закупка": "3300"}
]
}
}
5. DELETE — Удаление записи
Параметры: id (обязательно)
Пример:
DELETE http://127.0.0.1/test_api/?serviceid=.. ... api&id=111
Ответ:
{"code": 200, "id": "111"}
6. SQLSelect — Выполнение SELECT-запроса
Параметры: method=SQLSelect
Тело: JSON с полем "sql"
Пример:
POST http://127.0.0.1/test_api/?serviceid=.. ... =SQLSelect
{
"sql": "SELECT * FROM [Товары] WHERE [Группа] = 'Электроника'"
}
7. SQLExecute — Выполнение произвольного SQL
Параметры: method=SQLExecute
Тело: JSON с полем "sql"
Пример:
POST http://127.0.0.1/test_api/?serviceid=.. ... SQLExecute
{
"sql": "UPDATE t7 SET f28 = 'Мука' WHERE f28 = 'новое название'"
}
Загрузка файлов через Base64
Формат: data:[<mime-type>][;base64],<данные>
Поддерживаемые MIME-типы:
PNG (image/png) → .png
JPEG (image/jpeg) → .jpg
GIF (image/gif) → .gif
PDF (application/pdf) → .pdf
TXT (text/plain) → .txt
Word (application/vnd.openxmlformats...wordprocessingml...) → .docx
Excel (application/vnd.openxmlformats...spreadsheetml...) → .xlsx
Пример:
{
"Файл": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MK..."
}
Работа с подчинёнными таблицами (ключ _tables)
Структура:
{
"_tables": {
"Имя подчинённой формы": [
{"поле1": "значение1", "поле2": "значение2"},
{"id": "123", "поле1": "новое значение"}
]
}
}
Правила:
Нет id → создаётся новая запись (Append)
Есть id → открывается существующая запись на редактирование
PUT → полная замена (старые удаляются)
PATCH → добавление/обновление (старые сохраняются)
Коды ответов
0 — успешный GET
200 — успешные POST/PUT/PATCH/DELETE/SQL
400 — ошибка валидации, некорректный JSON
403 — отказано в доступе (неверный API-ключ)
404 — запись или форма не найдена
500 — внутренняя ошибка сервера
Важные особенности
Имена полей vs имена компонентов — в JSON всегда используйте имена полей (Объект), а не компонентов (dxLookupComboBox1).
Форматы дат/времени — даты: ДД.ММ.ГГГГ, время: ЧЧ:ММ:СС.
Вычисляемые поля — поля с Expression игнорируют попытки записи.
Обязательные поля — при создании записи через POST/PUT передавайте все обязательные поля; при обновлении через PATCH можно передавать только изменяемые.
Временные файлы — папка uploads используется только как буфер, после загрузки в BLOB временные файлы удаляются автоматически.
Методы API
1. GET — Получение данных
Параметры:
id — ID конкретной записи
filter — фильтр в синтаксисе DataExpress
expand — lookups, tables, queries, all, 1, true
Примеры:
Получить все записи:
http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
Получить запись по ID:
http://127.0.0.1/test_api/?serviceid=.. ... =api&id=21
Получить с фильтром:
http://127.0.0.1/test_api/?serviceid=.. ... pi&filter=[Флажок]=='1'
Получить с раскрытием lookup:
http://127.0.0.1/test_api/?serviceid=.. ... nd=lookups
Получить с подчинёнными таблицами и запросами:
http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&expand=all,lookups
2. POST — Создание записи
Тело запроса: JSON с парами "Имя поля": "Значение".
Особенности:
Lookup-поля: ID ("Объект": "9") или объект для создания ("Объект": {"Название": "Новая"})
Ключ _tables — массовое создание подчинённых записей
Файлы — через Base64 (data:...;base64,...)
Примеры:
Создать простую запись:
POST http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
{
"key": "Тест",
"Число": "42",
"Дата": "05.11.2026",
"Флажок": "1"
}
Создать с подчинёнными таблицами:
POST http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара
{
"Номер": "100",
"Дата": "05.11.2026",
"Клиент": "3",
"_tables": {
"Проданный товар": [
{"Товар": "1", "Количество": "2", "Закупка": "2300"},
{"Товар": "2", "Количество": "5", "Закупка": "36"}
]
}
}
Загрузить файл:
POST http://127.0.0.1/test_api/?serviceid=.. ... .&form=api
{
"key": "Документ",
"Файл": "data:application/pdf;base64,JVBERi0xLjQK..."
}
3. PUT — Полная замена записи
Параметры: id (в URL или теле JSON)
Особенности:
Все непереданные поля сбрасываются в null
Если _tables не передан — удаляются ВСЕ подчинённые записи
Если _tables передан — старые подчинённые записи удаляются, создаются новые
Примеры:
Полная замена родителя:
PUT http://127.0.0.1/test_api/?serviceid=.. ... m=api&id=1
{
"key": "Полная замена",
"Число": "100",
"Дата": "05.11.2026",
"Флажок": "1"
}
Полная замена с очисткой подчинённых таблиц:
PUT http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"Номер": "4",
"Дата": "23.03.2021",
"Клиент": "3"
}
4. PATCH — Частичное обновление
Параметры: id (в URL или теле JSON)
Особенности:
Обновляются только переданные поля, остальные сохраняются
Если _tables не передан — подчинённые записи не трогаются
Если _tables передан — добавляются новые или обновляются существующие по id
Примеры:
Обновление только одного поля:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... m=api&id=1
{
"key": "Обновлено через PATCH"
}
Добавление подчинённой записи:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"_tables": {
"Проданный товар": [
{"Товар": "3", "Количество": "10", "Закупка": "17"}
]
}
}
Обновление существующей подчинённой записи:
PATCH http://127.0.0.1/test_api/?serviceid=.. ... rm=Продажа товара&id=9
{
"_tables": {
"Проданный товар": [
{"id": "49", "Количество": "3", "Закупка": "3300"}
]
}
}
5. DELETE — Удаление записи
Параметры: id (обязательно)
Пример:
DELETE http://127.0.0.1/test_api/?serviceid=.. ... api&id=111
Ответ:
{"code": 200, "id": "111"}
6. SQLSelect — Выполнение SELECT-запроса
Параметры: method=SQLSelect
Тело: JSON с полем "sql"
Пример:
POST http://127.0.0.1/test_api/?serviceid=.. ... =SQLSelect
{
"sql": "SELECT * FROM [Товары] WHERE [Группа] = 'Электроника'"
}
7. SQLExecute — Выполнение произвольного SQL
Параметры: method=SQLExecute
Тело: JSON с полем "sql"
Пример:
POST http://127.0.0.1/test_api/?serviceid=.. ... SQLExecute
{
"sql": "UPDATE t7 SET f28 = 'Мука' WHERE f28 = 'новое название'"
}
Загрузка файлов через Base64
Формат: data:[<mime-type>][;base64],<данные>
Поддерживаемые MIME-типы:
PNG (image/png) → .png
JPEG (image/jpeg) → .jpg
GIF (image/gif) → .gif
PDF (application/pdf) → .pdf
TXT (text/plain) → .txt
Word (application/vnd.openxmlformats...wordprocessingml...) → .docx
Excel (application/vnd.openxmlformats...spreadsheetml...) → .xlsx
Пример:
{
"Файл": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MK..."
}
Работа с подчинёнными таблицами (ключ _tables)
Структура:
{
"_tables": {
"Имя подчинённой формы": [
{"поле1": "значение1", "поле2": "значение2"},
{"id": "123", "поле1": "новое значение"}
]
}
}
Правила:
Нет id → создаётся новая запись (Append)
Есть id → открывается существующая запись на редактирование
PUT → полная замена (старые удаляются)
PATCH → добавление/обновление (старые сохраняются)
Коды ответов
0 — успешный GET
200 — успешные POST/PUT/PATCH/DELETE/SQL
400 — ошибка валидации, некорректный JSON
403 — отказано в доступе (неверный API-ключ)
404 — запись или форма не найдена
500 — внутренняя ошибка сервера
Важные особенности
Имена полей vs имена компонентов — в JSON всегда используйте имена полей (Объект), а не компонентов (dxLookupComboBox1).
Форматы дат/времени — даты: ДД.ММ.ГГГГ, время: ЧЧ:ММ:СС.
Вычисляемые поля — поля с Expression игнорируют попытки записи.
Обязательные поля — при создании записи через POST/PUT передавайте все обязательные поля; при обновлении через PATCH можно передавать только изменяемые.
Временные файлы — папка uploads используется только как буфер, после загрузки в BLOB временные файлы удаляются автоматически.
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
Дополнительный план
1) для поля объекта добавить поиск по переданному тексту для POST, PUT, PATCH
2) Добавить передачу файлов/изображений во вложенные таблицы
3) Добавить передачу файлов/изображений в get в виде base64
4) Добавить передачу файлов/изображений в get в виде ссылки на папку в html веб-сервера (встроенная обработка передачи файлов)
1) для поля объекта добавить поиск по переданному тексту для POST, PUT, PATCH
2) Добавить передачу файлов/изображений во вложенные таблицы
3) Добавить передачу файлов/изображений в get в виде base64
4) Добавить передачу файлов/изображений в get в виде ссылки на папку в html веб-сервера (встроенная обработка передачи файлов)
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
Версия 9.0
1) Для поля объекта добавил поиск по переданному тексту для POST, PUT, PATCH, также по переданному тексту добавляется новая запись формы объекта, если не нашел подходящую, но пользоваться надо с осторожностью. Работает в том числе в вложенных таблицах.
2) Добавил передачу файлов/изображений во вложенные таблицы
1) Для поля объекта добавил поиск по переданному тексту для POST, PUT, PATCH, также по переданному тексту добавляется новая запись формы объекта, если не нашел подходящую, но пользоваться надо с осторожностью. Работает в том числе в вложенных таблицах.
2) Добавил передачу файлов/изображений во вложенные таблицы
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
Версия 10.0:
- expand=files: возврат файлов в GET в виде Base64 или URL (настраивается через files_url в apikey)
- Лимит размера загружаемых файлов (поле MaxFileSize в apikey, в МБ)
- Пейджинг для GET: параметры limit (дефолт 100, макс 1000) и offset
- GET с id=0: возврат JSON-шаблона формы для POST
Дополнительные поля в форме apikey:
- files_url (флажок): 1 = URL, 0 = Base64
- MaxFileSize (число): лимит в МБ (0 или пусто = файлы не принимаются)
- expand=files: возврат файлов в GET в виде Base64 или URL (настраивается через files_url в apikey)
- Лимит размера загружаемых файлов (поле MaxFileSize в apikey, в МБ)
- Пейджинг для GET: параметры limit (дефолт 100, макс 1000) и offset
- GET с id=0: возврат JSON-шаблона формы для POST
Дополнительные поля в форме apikey:
- files_url (флажок): 1 = URL, 0 = Base64
- MaxFileSize (число): лимит в МБ (0 или пусто = файлы не принимаются)
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru
- cordek
- Эксперт
- Сообщения: 2592
- Зарегистрирован: 14 май 2017, 14:53
- Благодарил (а): 765 раз
- Поблагодарили: 624 раза
- Контактная информация:
Универсальный модуль HTTP сервера для API
Я попросил DeepSeek проанализировать код версии 10.0 и получил много замечаний по безопасности и по производительности. Большую часть замечаний закрыли. Редактировал код Qwen, проверял DeepSeek. Тестировал с помощью автотестов на Python в разных вариантах и сценариях использования.
Для версии 10.7 устранены замечания DeepSeek по безопасности и производительности:
- БЕЗОПАСНОСТЬ: Безопасный поиск компонентов через try..except во всех местах.
- ИСПРАВЛЕНИЕ URL: ExtractBlobToHtml возвращает абсолютный путь '/html/files/...'.
- BASE64: Использование встроенных DecodeBase64/EncodeBase64 для корректной работы
с бинарными данными (решает проблему Unicode-повреждений). BASE64: Strict=False для корректной обработки unpadded base64. BASE64: Валидация base64 символов до декодирования.
- Строгая валидация полей. Теперь сервер возвращает ошибку 400 с детальным массивом errors, где указано, какое именно поле не найдено.
- При ошибках загрузки файлов запись не сохраняется.
- Попытки загрузить файлы через пути с .. или : (например, ..\..\Windows\win.ini) теперь блокируются на уровне сервера.
- Изменение поведения expand=all. Ранее параметр expand=all раскрывал таблицы, запросы и файлы, но не включал раскрытие lookup-полей. Теперь expand=all раскрывает всё, включая lookup. Для обратной совместимости можно использовать expand=tables,queries,files без lookups.
- Пейджинг: Дефолтный limit теперь равен 100 (ранее был неограничен). Максимальный limit ограничен 1000 (ранее не ограничивался). Если клиент не указал limit, сервер вернёт в ответе поле "limit": 100.
- При использовании ключа с files_url=1 сервер теперь возвращает абсолютный путь /html/files/... вместо относительного html/files/...
- POST с пустым телом или только _tables (без полей родителя) теперь возвращает 400 вместо 500.
- PUT с одним полем возвращает корректный JSON. Ранее в ответе мог появиться невалидный JSON вида {"updated": {, "field":"value".
- Все SQL-запросы к таблице apikey используют экранирование кавычек для защиты от инъекций.
- Устранены N+1 запросы при раскрытии _queries в GET-запросах. Структура запросов теперь кэшируется до начала обработки записей.
- Все control-символы (#0..#31) в текстовых полях теперь корректно экранируются в JSON-ответах.
- Ошибки в дочерних таблицах (невалидные файлы, lookup, типы данных) теперь возвращаются клиенту в виде детального массива errors с указанием таблицы, ID записи и поля.
Никаких изменений в базе данных делать не нужно. Все существующие ключи продолжат работать.
Для версии 10.7 устранены замечания DeepSeek по безопасности и производительности:
- БЕЗОПАСНОСТЬ: Безопасный поиск компонентов через try..except во всех местах.
- ИСПРАВЛЕНИЕ URL: ExtractBlobToHtml возвращает абсолютный путь '/html/files/...'.
- BASE64: Использование встроенных DecodeBase64/EncodeBase64 для корректной работы
с бинарными данными (решает проблему Unicode-повреждений). BASE64: Strict=False для корректной обработки unpadded base64. BASE64: Валидация base64 символов до декодирования.
- Строгая валидация полей. Теперь сервер возвращает ошибку 400 с детальным массивом errors, где указано, какое именно поле не найдено.
- При ошибках загрузки файлов запись не сохраняется.
- Попытки загрузить файлы через пути с .. или : (например, ..\..\Windows\win.ini) теперь блокируются на уровне сервера.
- Изменение поведения expand=all. Ранее параметр expand=all раскрывал таблицы, запросы и файлы, но не включал раскрытие lookup-полей. Теперь expand=all раскрывает всё, включая lookup. Для обратной совместимости можно использовать expand=tables,queries,files без lookups.
- Пейджинг: Дефолтный limit теперь равен 100 (ранее был неограничен). Максимальный limit ограничен 1000 (ранее не ограничивался). Если клиент не указал limit, сервер вернёт в ответе поле "limit": 100.
- При использовании ключа с files_url=1 сервер теперь возвращает абсолютный путь /html/files/... вместо относительного html/files/...
- POST с пустым телом или только _tables (без полей родителя) теперь возвращает 400 вместо 500.
- PUT с одним полем возвращает корректный JSON. Ранее в ответе мог появиться невалидный JSON вида {"updated": {, "field":"value".
- Все SQL-запросы к таблице apikey используют экранирование кавычек для защиты от инъекций.
- Устранены N+1 запросы при раскрытии _queries в GET-запросах. Структура запросов теперь кэшируется до начала обработки записей.
- Все control-символы (#0..#31) в текстовых полях теперь корректно экранируются в JSON-ответах.
- Ошибки в дочерних таблицах (невалидные файлы, lookup, типы данных) теперь возвращаются клиенту в виде детального массива errors с указанием таблицы, ID записи и поля.
Никаких изменений в базе данных делать не нужно. Все существующие ключи продолжат работать.
балуюсь разработкой LIMS JDX
cordek {/а} yandex/ru
cordek {/а} yandex/ru