Первый API-запрос

Базовый адресCopy Anchor Link

Используйте HTTPS-домен установленной CMS и префикс /api/v1:

export CMS_ORIGIN='https://cms.example.com'
curl --fail-with-body --show-error "$CMS_ORIGIN/api/v1/listings?page=1&limit=10" \
  --header 'Accept: application/json'

cms.example.com замените адресом своей установки. Ответ зависит от опубликованных объявлений, вертикали и фильтров. page и limit — параметры этого примера; параметры других операций могут отличаться.

Авторизованный запросCopy Anchor Link

Получите токены по инструкции. Передайте access-токен через защищённое хранилище секретов клиента:

GET /api/v1/auth/me
Host: cms.example.com
Accept: application/json
Authorization: Bearer ACCESS_TOKEN

Используйте собственную тестовую учётную запись. Административная роль требуется для операций, которые её проверяют.

API ReferenceCopy Anchor Link

1. Найдите операцию по назначению или маршруту.
2. Проверьте HTTP-метод, path/query-параметры и тип тела.
3. Сверьте авторизацию и доступность для своей вертикали.
4. Замените базовый адрес примера доменом CMS.
5. Проверьте ответ и фактическое состояние объекта.

Отсутствие операции в справочнике не доказывает отсутствие функции в интерфейсе: модуль может иметь собственный API, а служебный маршрут исключается из публичного контракта.

Проверка результатаCopy Anchor Link

Начинайте с чтения. Изменения проверяйте на тестовом объекте, затем прочитайте его повторно и откройте в интерфейсе. При тайм-ауте проверьте результат предыдущего запроса до повтора: универсальная идемпотентность всех POST-операций не гарантируется.

Проверьте отказ без токена, с истёкшей сессией, без нужной роли и с неверными параметрами. См. ошибки и диагностику.