Введение
У каждой базы в Nodul Таблицах есть своя документация API. Она создаётся автоматически по таблицам и полям базы, поэтому в ней сразу видны настоящие названия полей, их ID и готовые примеры запросов. Откройте её, если хотите работать с базой напрямую по API: подключить её к внешней системе или писать запросы вручную. Для узлов в сценарии Nodul она не нужна.
Как открыть
- Откройте table.nodul.ru.
- В блоке «Ваши рабочие пространства» нажмите ⋮ на карточке нужной базы данных.
- Выберите Документация API.
В заголовке меню рядом с названием базы указан её ID, например «Contract Management (25)».
Что внутри
Слева меню разделов, в центре описание, справа пример запроса на cURL.
- Введение: ID базы и примеры клиентов: axios для JavaScript и requests для Python.
- Аутентификация: как передать токен в запросе. Сам токен создаётся в настройках: Получение API-токена.
- Таблица … (id): отдельный пункт для каждой таблицы базы. В скобках указан ID таблицы, он нужен почти во всех запросах.
- Загрузка файлов, Список таблиц, Фильтры, HTTP-ошибки: общие разделы, одинаковые для любой базы.
API работает по REST: данные передаются в JSON, результат сообщается стандартными HTTP-кодами.
Когда схема меняется
Если добавить, переименовать или удалить таблицу или поле, документация базы обновится сама. Запросы в вашей системе при этом не поменяются, поэтому сверьте их с новой версией документации.
Нужна помощь? Спросите сообщество
Если на странице не хватает деталей или что-то непонятно, напишите на форуме сообщества Nodul: команда и другие пользователи обычно отвечают быстро.
Программное обеспечение распространяется в виде интернет-сервиса, специальные действия по его установке на стороне пользователя не требуются.