Работа с REST API

АСР Platex® предоставляет программный интерфейс доступа ко всему функционалу через документированный REST API. Это позволяет:

  • взаимодействовать с компонентами системы с любых устройств;
  • интегрировать АСР с внешними системами (CRM, ERP и т. д.);
  • автоматизировать процессы (выборка данных для отчётности, добавление клиентов и т. д.).

Документация к REST API предоставляется в формате OpenAPI (Swagger). Актуальную версию можно сгенерировать прямо в интерфейсе АСР Platex®.

Важные замечания

  • REST API для внешних задач работает с БД под отдельной учётной записью.
  • API зарегистрирован как отдельное приложение: Platex OpenAPI.
  • Для каждой задачи рекомендуется создавать отдельное приложение с индивидуальной учётной записью.

Доступ к REST API

Для настройки доступа к REST API необходимо:

  • Шаг 1 – Создать приложение для REST API;
  • Шаг 2 – Создать внешнего пользователя;
  • Шаг 3 – Сгенерировать документацию.

Создание приложения для REST API

  1. Перейдите в меню «Служебное» → вкладка «Безопасность» → вкладка «Сервисы и приложения».
  2. Щёлкните правой кнопкой мыши по записи Platex OpenAPI → в контекстном меню выберите «Создать дочернюю запись».
  3. Заполните обязательные поля:
    • Приложение (род.): автоматически подставится Platex OpenAPI;
    • Тип учётных записей: выберите «Внешние приложения»;
    • Внешний тип подключения: выберите «Внешние приложения»;
    • Роль по умолчанию: выберите роль с нужными правами (от неё зависит набор доступных API‑вызовов);
    • Имя пользователя БД: укажите имя для подключения REST API;
    • Код: уникальный код приложения;
    • Полное наименование: понятное название приложения;
    • Примечание: пояснение для администраторов системы;
    • Флаг «Заблокировано»: активируйте, если нужно временно запретить подключение.
  4. Нажмите Добавить.

Создание внешнего пользователя и учётной записи

  1. Перейдите в меню «Справочники» → раздел «Компания» → раздел «Пользователи» → «Внешние».
  2. Нажмите кнопку Создать — откроется форма редактирования.
  3. Укажите:
    • Роль (должна соответствовать роли по умолчанию из шага 1);
    • Код;
    • Полное наименование.
  4. В подчинённой таблице «Учётные записи» нажмите Создать — откроется форма редактирования.
  5. Заполните обязательные поля:
    • Логин;
    • Пароль;
    • Вид логина: выберите «Обычный»;
    • Тип учётных записей: выберите «Внешние приложения».
  6. Нажмите Сохранить.

Генерация документации OpenAPI (YAML)

  1. Вернитесь в меню «Служебное» → вкладка «Безопасность» → вкладка «Сервисы и приложения».
  2. Найдите созданное приложение → щёлкните правой кнопкой мыши → выберите «Экспорт OpenAPI YAML».
  3. В открывшемся окне укажите:
    • Имя приложения;
    • Логин;
    • Пароль.
  4. Нажмите Экспорт и дождитесь скачивания YAML‑файла.

Работа с документацией OpenAPI

Для удобной работы с API‑документацией используйте Swagger Editor или совместимые инструменты:

  1. Откройте Swagger Editor (рекомендуется использовать self-hosted версию).
  2. Импортируйте скачанный YAML‑файл.
  3. Просмотрите описание доступных вызовов REST API, включая:
    • эндпоинты (URL‑адреса);
    • методы (GET, POST, PUT, DELETE и т. д.);
    • параметры запросов и ответов;
    • коды ошибок и их описание.