Пропустить до содержимого
Документация

Быстрый старт — Swagger UI

Что такое Swagger

Swagger — инструмент для документирования и тестирования API. Он позволяет:

  • просматривать все конечные точки и параметры;
  • формировать запросы и видеть curl-эквиваленты;
  • получать ответы в реальном времени.

Авторизация через API-ключ

Swagger UI поддерживает схему авторизации по API-ключу:

  1. Нажмите Authorize в правом верхнем углу.
  2. Выберите схему apikey (заголовок apikey).
  3. Вставьте ваш ключ и подтвердите.

После этого Swagger автоматически подставит заголовок apikey в все запросы.

Все примеры в Swagger используют https://v2.gosplan.info.

Пример запроса

  1. Откройте раздел 44-ФЗ → purchases → GET /fz44/purchases.
  2. Нажмите «Try it out». Установите параметры limit и skip.
  3. Нажмите «Execute» и изучите cURL, URL и ответ.

Swagger покажет, как выглядит запрос с заголовком apikey.

Типичные коды ответов

  • 200 OK — запрос выполнен успешно.
  • 401 Unauthorized — ключ не передан или указан неверно.
  • 403 Forbidden — ключ найден, но срок действия истёк или доступ запрещён.
  • 429 Too Many Requests — превышен лимит; см. «Тарифы и лимиты».
  • 5xx — внутренняя ошибка, повторите позже.

Что дальше