Syntax highlighting of Home

= Введение =

== О проекте ==

Проект '''ГосПлан''' представляется собой набор сервисов, направленных на интеграцию с государственными закупками. Проект запущен в 2018м году. Базовыми публичными сервисами проекта '''ГосПлан''' являются веб-сервисы, которые предоставляют API к документам Единой информационной системе в сфере закупок (ЕИС Закупки, [[https://zakupki.gov.ru]]). Данный ресурс описывает вторую версию API, который запущен в 2025 году. Информация об API v1 приведена [[ v1 | здесь ]].

== Возможности API ==

Сервис предоставляет следующие данные:

 . по '''44-ФЗ''': планы-графики закупок, закупки (извещения, протоколы и др. документы), процедуры заключения контрактов, контракты. Начало загрузки документов - 01.01.2024.
 . по '''223-ФЗ''': планы закупок, закупки (извещения, протоколы и др. документы), договоры. Начало загрузки документов - 01.10.2024.
 . по '''ПП РФ 615''': закупки (извещения, протоколы и др. документы), контракты. Начало загрузки документов - 01.01.2025.

Ориентировочный период хранения данных - '''3 года'''.

== Состав сервиса ==

 . '''Продуктивный сервер''' - [[https://v2.gosplan.info]]. Сервер предоставляет данные по REST протоколу. Для получения данных требуется API ключ (c 01.07.2025).
 . '''Тестовый сервер''' - [[https://v2test.gosplan.info]]. Почти тоже самое, что и продуктивный сервер с количественными ограничениями по запросам. Для получения данных API ключ '''НЕ''' требуется. Рекомендуется использовать для демонстрационных целей, быстрого старта, работы в swagger  [[ https://swagger.gosplan.info ]].
 . '''Описание API методов''' - [[ https://swagger.gosplan.info ]]. Содержит подпробное описание API методов, а также историю изменений

== Архитектура сервиса ==

Сервис предоставляет JSON-данные по REST-протоколу и реализован на ''Python3'' с использованием [[https://fastapi.tiangolo.com/|FastAPI]]. API обеспечивает обработку входящих запросов с высокой производительностью и удобным документированием. Запросы обрабатываются синхронно, а выполнение сложных вычислений делегируется фоновым процессам.

Для хранения данных используется [[https://www.mongodb.com/|MongoDB]], выступающая в роли основного хранилища. В базе данных содержатся как оперативные, так и исторические данные, а также метаданные для внутренней обработки.

В качестве промежуточного хранилища для больших объемов данных, временных файлов и резервных копий используется [[https://aws.amazon.com/s3/|S3-совместимое хранилище]]. Оно применяется для обмена данными между сервисами, а также для хранения подготовленных файлов перед загрузкой в основную базу данных.

Фоновая обработка данных, включая их загрузку, очистку и агрегацию, управляется системой [[https://airflow.apache.org/|Apache Airflow]], которая организует выполнение задач в виде DAG (Directed Acyclic Graph).

Развертывание и обновление сервисов осуществляется с помощью [[https://argo-cd.readthedocs.io/|ArgoCD]], который отслеживает изменения в репозитории конфигураций и автоматически применяет их в [[https://kubernetes.io/|Kubernetes]]-кластере. Это позволяет реализовать GitOps-подход и обеспечить предсказуемость обновлений. 

Для обеспечения отказоустойчивости в случае инфраструктурных сбоев у основного провайдера сервис поддерживает Disaster Recovery (DR) окружение. DR-окружение развернуто в альтернативном дата-центре и синхронизируется с основной системой. При возникновении проблем с доступностью основной инфраструктуры выполняется автоматическое переключение на резервный контур с минимальным временем простоя.

== Полезные ссылки ==

 . вики - [[https://wiki.gosplan.info]]
 . описание API 44-ФЗ в формате swagger - [[https://swagger.gosplan.info/?urls.primaryName=44-ФЗ]]
 . описание API 223-ФЗ в формате swagger - [[https://swagger.gosplan.info/?urls.primaryName=223-ФЗ]]
 . описание API ПП РФ 615 в формате swagger  - [[https://swagger.gosplan.info/?urls.primaryName=ППРФ-615]]

= Начало работы =

== Регистрация и аутентификация ==

В настоящее время регистрация и аутентификациия к продуктовому серверу [[ https://v2.gosplan.info ]] не требуется. Доступ к API предоставляется на свободной основе до '''01.07.2025'''. После окончания бесплатного периода доступ будет осуществляться по '''API ключу''.

{{{#!wiki note
Информация о получении и использовании API ключа будет опубликована в ближайшее время.
}}}

Доступ к тестовому серверу [[ https://v2test.gosplan.info ]] подразумевается без регистрации и аутентификации, но с ограничениями по количеству запросов.

== Быстрый старт ==

Здесь вы найдете всю необходимую информацию для того, чтобы начать работу с '''ГосПлан API v2''' за считанные минуты. Подготовлены простые инструкции, которые помогут вам протестировать функциональность сервиса через командную строку, язык программирования python, а так же с использованием Swagger — удобного инструмента для взаимодействия с API.

Для выполнения запросов не требуется регистрация и аутентификация.

Пример простого запроса с использованием curl

{{{#!highlight bash
# --- самая "дорогая" закупка по 44-ФЗ (на момент составления wiki)
curl -s 'https://v2test.gosplan.info/fz44/purchases?sort=max_price_desc&limit=1' | jq .[].max_price
90946085143.0
}}}

Быстрый старт для:

 . [[docs/quickstart-curl | Командная строка]]
 . [[docs/quickstart-python | Python]]
 . [[docs/quickstart-swagger | Swagger ]]

== Инструкции == 

 . [[ docs/howto-start | Получение доступа к API ]]
 . [[ docs/howto-xsd | Схемы документов ]]
 . [[ docs/howto-history | Исторические данные ]]



== Документы ==

Обмен данными в ЕИС производится в формате XML с использованием протокола [[ https://en.wikipedia.org/wiki/AS2 | AS2 ]] ([[http://www.ietf.org/rfc/rfc4130.txt]]). Разделы информационной системы содержат различные XML-документы с различной структурой. Ниже приводится описание докумнетов, которые предоставляются через ГосПлан API.

=== Типы документов ===

 . [[ docs/tenderplans | Планы-графики ]]
 . [[ docs/purchases | Закупки ]]
 . [[ docs/procedures | Процедуры заключения контрактов ]]
 . [[ docs/contracts | Контракты ]]

=== Справочники ===

Раздел содержит полезные справочные данные, которые используются в API

 . [[docs/regions-kladr | Коды регионов по КЛАДР]]
 . [[docs/okpd2 | ОКПД2 ]]
 . [[docs/ktru | КТРУ ]]
 . [[docs/nsiSpecialPurchases2020 | Типы особых закупок ]]



== Правовые документы и реквизиты ==

 . [[ legal/API-Usage-Agreement-v2 | Соглашение об использовании API ]]
 . [[ legal/requisites | Реквизиты ]]



== Контакты ==

По всем вопросам работы сервисов '''ГосПлан API v2''' обращайтесь по контактным данным ниже:
 . почта - [[mailto:apiv2@gosplan.info | apiv2@gosplan.info]]
 . телеграмм - [[ https://t.me/gosplan_project ]]