Быстрый старт: Работа с API через Swagger
Добро пожаловать в раздел "Быстрый старт" для работы с ГосПлан API v2 через Swagger! Этот раздел предназначен для аналитиков, тестировщиков и разработчиков, которые предпочитают использовать удобный и интерактивный инструмент для тестирования и изучения API. Swagger UI предоставляет простой веб-интерфейс, который позволяет вам отправлять запросы, просматривать ответы и исследовать доступные конечные точки (endpoints) без необходимости написания кода.
Что такое Swagger?
Swagger https://swagger.io — это мощный инструмент для документации и тестирования API. С его помощью вы можете:
- Просматривать все доступные конечные точки и их параметры.
- Формировать запросы с автоматической подстановкой значений.
- Получать и анализировать ответы API в реальном времени.
- Экспериментировать с различными сценариями использования API.
Как начать:
- Откройте Swagger UI: Перейдите по ссылке: https://swagger.gosplan.info
- Переключите раздел API: в правом верхнем углу в поле Select a definition выберите необходимый раздел API - 44-ФЗ / 223-ФЗ / ПП РФ 615
- Изучите доступные конечные точки: В Swagger UI вы увидите список всех доступных endpoint'ов с подробным описанием их функционала.
- Тестируйте API: Выберите интересующую вас конечную точку, заполните необходимые параметры и отправьте запрос. Swagger автоматически сформирует запрос и покажет ответ.
Пример использования:
Допустим, вы хотите получить список закупок с ограничением количества результатов (limit) и смещением (offset):
- Найдите конечную точку /fz44/purchases в Swagger UI - https://swagger.gosplan.info/?urls.primaryName=44-ФЗ#/Закупки/getPurchases
- Нажмите кнопку "Try it out", чтобы получить возможность редактировать параметры.
- Укажите параметры запроса: limit: 10, skip: 0.
- Нажмите кнопку Execute для выполнения запроса.
- Просмотрите ответ в формате JSON, который будет отображен на экране.
Выбор метода для выполнения
Редактирование параметров запроса
Выполнение запроса
Ответ от сервера
Что дальше?
Для выполнения запросов по этой инструкции аутентификация не требуется и актуальность данных соответствует продуктовому сервису. При этом на тестовом сервере https://v2test.gosplan.info существует значительное ограничение на количество запросов. Для получения полного доступа к функционалу API вам потребуется зарегистрироваться на платформе и получить API-ключ (см. раздел "Регистрация и аутентификация" на главной странице).
Если возникнут вопросы, обратитесь к разделу Частые вопросы на главной странице или свяжитесь со службой поддержки (раздел "Контакты" на главной странице).