Помощь. Работа API
| Вызов api: /api/{имя базы}/[{cmd}/{id объекта}][?{параметры}] cmd: _d_* — изменение структуры данных (DDL, команды Редактора типов); _m_* — изменение самих данных (DML, команды базового интерфейса); остальные команды возвращают JSON с данными, используемыми системой для построения форм. Все запросы на изменение данных отправляются как post и требуют токен XSRF (параметр _xsrf). Ответом является набор параметров для создания следующего экрана базового интерфейса, как если бы команда была подана формой интерфейса, или сообщение об ошибке. По команде auth клиент получает токен, который далее передает в заголовке X-Authorization={токен} для всех запросов. | |||||||
| cmd | Метод | id объекта | Описание | params | Пример запроса | Пример ответа | Массив данных |
| auth | post | Авторизация пользователя, возвращает токены XSRF и авторизации | login={пользователь} pwd={пароль} |
/api/andy/auth POST-параметры: pwd=******* login=andy |
Успешно: {«_xsrf»:»ef1bbd56839b1e97636a5″,»token»:»67a450965bf763cd719b5fcdb4ca41″,»msg»:null} Неуспешно: {«failed»:»wrong»} |
||
| _d_alias | post | id | Сохранить псевдоним для ссылочного реквизита | val={значение} | |||
| _d_attrs | post | id | Сохранить атрибуты реквизита (значение по умолчанию) | val={значение} | |||
| _d_del | post | id | Удалить тип | ||||
| _d_del_req | post | id | Удалить реквизит | ||||
| _d_multi | post | id | Включить/отключить множественный выбор для ссылочного рквизита | ||||
| _d_new | post | — | Создать новый тип (таблицу) | val={значение} unique=1 (1 — первая колонка уникальна, пусто — нет) t={id базового типа} |
|||
| _d_null | post | id | Установить/Снять флаг «Обязательный» у реквизита | ||||
| _d_ref | post | id | Создать ссылку на тип | ||||
| _d_req | post | id | Добавить реквизит | t={id типа реквизита} | /api/andy/_d_req/18?t=322 POST-параметры: _xsrf=d0aff7cd045d1b1 |
{«id»:1826,»obj»:18,»next_act»:»edit_types»,»args»:»ext»,»warnings»:»»} | |
| _d_save | post | id | Сохранить имя типа, его базовый тип и признак уникальности | val={значение} unique=1 (передавать если установлен) t={id базового типа} |
|||
| _d_up | post | id | Переместить реквизит на 1 позицию выше среди равных | /api/andy/_m_up/165 POST-параметры: _xsrf=d0aff7cd045d1b1 |
{«id»:»116″,»next_act»:»object»,»args»:»F_U=145″} | ||
| _m_del | post | id | Удаление объекта | ||||
| _m_move | post | id | Перемещение подчиненного ообъекта под другого родителя | up={id целевого родителя} | |||
| _m_new | post | id типа | Создание объекта заданного типа | Объект: t{id типа}={значение} Для подчиненного типа: up={id родителя} Необязательно: Реквизиты: t{id типа}={значение} |
|||
| _m_save | post | id | Сохранить значение и реквизиты объекта, если они заданы | Объект: t{id типа}={значение} Реквизиты: t{id типа}={значение} |
|||
| _m_set | post | id | Изменить / создать / удалить реквизит объекта | Реквизиты: t{id типа}={значение} |
/api/andy/_m_set/165 t115=145 POST-параметры: _xsrf=d0aff7cd045d1b1 |
||
| _m_up | post | id | Переместить объект на 1 позицию выше среди равных | ||||
| backup | post | id | Создать архив базы (в разработке) | ||||
| dict | get | — | Список независимых типов объектов | /api/andy/dict | { «18»: «User», «22»: «Query», «29»: «Format», «42»: «Role», «47»: «Grant», «63»: «Function», «65»: «Total», «137»: «Form» } |
Список типов как объект | |
| dir_admin | get, post | — | Список файлов и директорий, действия с ними | ||||
| edit_obj | get | id | Данные для формы редактирования объекта | ||||
| edit_types | get | — | Данные для Редактора типов | ||||
| object | get, post | id типа | Данные для формы списка экземпляров типа объекта, команда на удаление | _m_del_select — если этот параметр передан, то будут удалены все объекты, попадающие под текущий фильтр | /api/andy/object/1141 | { «type»: { «id»: 1141, «up»: 1, «val»: «Plan», «base»: «SHORT» }, «base»: { «id»: «3» }, «req_base»: { «1274»: «SIGNED» }, «req_base_id»: { «1274»: «14» }, «req_attrs»: { «1274»: «» }, «req_type»: { «1274»: «Price» }, «req_order»: [ «1274» ], «object»: [ { «id»: «1146», «up»: «1», «val»: «Free», «base»: «1141» }, { «id»: «1148», «up»: «1», «val»: «Scalable», «base»: «1141» }, { «id»: «1147», «up»: «1», «val»: «Startup», «base»: «1141» } ], «reqs»: { «1146»: { «1274»: «0.00» }, «1147»: { «1274»: «650.00» }, «1148»: { «1274»: «1950.00» } }, } |
Данные для построения таблицы |
| report | get, post | id отчета | Данные выполненного запроса (отчета), параметры, команда на выполнение изменений | _m_confirmed — если этот параметр установлен, то выполнятся изменения запроса | |||
Контакты для связи
Свяжитесь с нами в рабочее время:
🕒 Пн–Пт: 9:00 – 19:00 — отвечаем быстро!
📞 В выходные дни мы тоже готовы ответить на ваши вопросы и помочь в кратчайшие сроки.
Мы всегда вам рады. Свяжитесь с нами прямо сейчас и начните работать с Таблис!