Перейти к содержанию

REST API

RESTful API Grav обеспечивает headless-доступ к контенту, медиафайлам, конфигурации, пользователям и управлению системой вашего сайта. Создан для ИИ-агентов, пользовательских фронтендов, мобильных приложений и административного интерфейса нового поколения.

В этом разделе

  • Начало работы — Плагин Grav API добавляет к вашему сайту RESTful API, обеспечивая полноценный headless-доступ к страницам, медиафайлам, конфигурации, пользователям и управлению системой.
  • Аутентификация — API поддерживает три метода аутентификации, которые проверяются в таком порядке: ключ API, JWT, затем сессия. Запросы к публичным эндпоинтам (всё под /auth/, переводы, миниатюры и /ping) пропускают аутентификацию.
  • Справочник REST API — Полный справочник эндпоинтов REST API с параметрами, примерами и кодами ответов. Все эндпоинты имеют префикс настроенного маршрута (по умолчанию: /api/v1).
  • События — API вызывает события до и после каждой операции записи и использует события, чтобы позволить плагинам расширять интерфейс Admin2 (боковые панели, панели меню, виджеты, контекстные панели, панели настроек, компоненты пользовательских полей, пользовательские отчёты)…
  • Руководство разработчика — Это руководство описывает, как разработчики плагинов могут интегрироваться с Grav API и Admin2 — новым SPA-плагином админки на Svelte 5 (работающим на API), который заменяет устаревший классический плагин Admin в Grav 2.0.