mxApi — быстрый внешний API для MODX Revolution

  • mxApi превращает MODX в нормальную публичную API-платформу: с единым входом, bearer-токенами, правами доступа, каталогом эндпоинтов и OpenAPI-
    документацией.
  • Пакет доступен для MODX Revolution 2 и MODX Revolution 3, поэтому его можно использовать и на старых боевых проектах, и на новых установках MODX.
  • Полная документация: https://docs.modx.pro/components/mxapi

Главная идея
Больше не нужно каждый раз изобретать свой auth.php, набор случайных сниппетов, секретные GET-параметры и отдельную самописную
документацию. mxApi даёт общий каркас, а вы подключаете к нему нужные эндпоинты.
Быстрый API для стандартных процессоров MODX
  • mxApi особенно полезен, когда нужно быстро открыть внешний доступ к существующей логике MODX: стандартным процессорам, процессорам пакетов,
    операциям с ресурсами, пользователями, заказами, справочниками или любыми другими действиями, которые уже живут внутри проекта.
  • Вы описываете endpoint, указываете нужный processor, входные параметры, scope и право MODX, а mxApi берёт на себя роутинг, авторизацию, проверку
    доступа, формат ответа и журналирование.
  • Это удобный путь для интеграций с CRM, складом, мобильным приложением, BI-системой, внешним каталогом, партнёрским сервисом или любым клиентом,
    которому нужен предсказуемый API вместо прямого доступа в админку или базу.
Свои API без боли
  • Если стандартного processor недостаточно, можно писать собственные провайдеры и обработчики: ядро mxApi не ограничивает вас одним сценарием.
  • Эндпоинты могут приходить из самого mxApi, из других пакетов или из кода конкретного сайта. Это позволяет собрать аккуратный API под проект, не
    смешивая бизнес-логику с роутером и авторизацией.
  • Каждый endpoint сам объявляет свои метаданные, параметры, scope и требуемое право MODX. Из этого же живого реестра строятся каталог в админке и
    OpenAPI-выгрузка.
Креды, токены и права доступа

  • mxApi поддерживает bearer-токены для пользователей MODX по логину и паролю, а также машинные клиенты с парой client_id и client_secret.
  • Для интеграций можно выдавать разные наборы scope: одному клиенту только чтение заказов, другому создание заявок, третьему доступ к справочникам
    или своим кастомным операциям.
  • Права проверяются через штатный механизм политик MODX на namespace mxapi. Это значит, что доступом можно управлять привычным способом: через
    пользователей, группы, политики и permissions.
  • В базе хранится только sha256-хэш токена, а отзыв доступа применяется сразу.
Самоописание API одним запросом
  • Важная фишка mxApi: интеграции не нужно вручную передавать отдельный список методов в письме, таблице или устаревающем файле.
  • Вы создаёте пользователя или машинного клиента, выдаёте ему креды и нужные scope, а дальше он сам получает описание доступных ему методов одним
    запросом к /mxapi/v1/meta/endpoints.
  • Ответ строится по реальному реестру endpoint-ов и учитывает права текущего токена: клиент видит именно те методы, которые ему разрешены.
  • Это сильно упрощает подключение внешних разработчиков, CRM, складов, мобильных приложений и любых партнёрских интеграций.
Что уже встроено
  • Собственный префикс маршрутов, по умолчанию /mxapi/v1.
  • Bearer-аутентификация для пользователей и машинных клиентов.
  • Scope и MODX-права для каждого эндпоинта.
  • Реестр endpoint-ов с метаданными.
  • Каталог API в админке.
  • OpenAPI-выгрузка без отдельных YAML-файлов, которые устаревают отдельно от кода.
  • Ограничение частоты запросов.
  • Идемпотентность для изменяющих вызовов.
  • Журнал обращений: кто, когда, каким токеном, в каком контексте и с каким результатом обращался к API.
  • Endpoint /mxapi/v1/meta/endpoints, где клиент может получить список доступных ему методов по своему токену.
  • Каталог API в админке и OpenAPI-выгрузка без отдельных YAML-файлов, которые устаревают отдельно от кода.

Для кого этот пакет
  • Для разработчиков, которым нужно быстро и безопасно открыть внешний API к MODX-проекту.
  • Для интеграций с CRM, складами, платёжными сервисами, мобильными приложениями, личными кабинетами и внешними витринами.
  • Для команд, которым важно не просто “дать ссылку”, а получить управляемый API с правами, токенами, документацией и аудитом.
Бесплатно
mxApi — абсолютно бесплатный пакет. Можно ставить, использовать в проектах, писать свои провайдеры, подключать интеграции и строить
полноценный внешний API поверх MODX без отдельной оплаты за сам пакет.
Артур Шевченко
Артур Шевченко
6 часов назад
modx.pro
38
Поблагодарить автора Отправить деньги

Комментарии: 0

Авторизуйтесь или зарегистрируйтесь, чтобы оставлять комментарии.
0