Syntax highlighting of 0c941d9 ~( docs/quickstart-curl)

= Быстрый старт: Работа с API в терминале =

Добро пожаловать в раздел "Быстрый старт" для работы с '''ГосПлан API v2''' через командную строку! Этот раздел предназначен для разработчиков, которые хотят быстро протестировать базовые возможности нашего сервиса. Для выполнения запросов по этой инструкции не требуется аутентификация , что позволяет вам сразу приступить к тестированию.

Мы будем использовать два мощных инструмента:

 . `curl` : Универсальный инструмент для выполнения HTTP-запросов. Если он еще не установлен на вашей системе, вы можете скачать его по ссылке: [[https://curl.se/download.html]] .
 . `jq` : Утилита для анализа и форматирования JSON-данных. Она поможет вам легко читать и фильтровать ответы API. Скачать jq можно здесь: [[https://stedolan.github.io/jq/download/]] .

Как начать:
 1. Откройте терминал или командную строку.
 1. Используйте примеры запросов ниже для отправки HTTP-запросов к API.
 1. Анализируйте ответы с помощью jq, чтобы лучше понять структуру данных.

Пример первого запроса - проверка доступности сервера

{{{#!highlight bash
curl -X GET -s 'https://v2test.gosplan.info' | jq
{
  "app version": "1.0.0a9",
  "API version": "v2.0.5",
  "API description": "https://swagger.gosplan.info"
}
}}}

Получаем самую "дорогую" закупку по 44-ФЗ (на момент составления wiki)

{{{#!highlight bash
curl -X GET -s 'https://v2test.gosplan.info/fz44/purchases?sort=max_price_desc&limit=1' | jq .[].max_price
90946085143.0
}}}

= Что дальше? =

Для выполнения запросов по этой инстуркции аутентификация не требуется и актуальность данных соответствует продуктовому сервису. При этом на тестовом сервере [[ https://v2test.gosplan.info ]] существует значительное ограничение на количество запросов. Для получения полного доступа к функционалу API вам потребуется зарегистрироваться на платформе и получить API-ключ (см. раздел "Регистрация и аутентификация" на главной странице).

Кроме того, будет полезным ознакомиться с описанием API методов на ресурсе [[https://swagger.gosplan.info]].

Если возникнут вопросы, обратитесь к разделу ''Частые вопросы'' на главной странице или свяжитесь со службой поддержки (раздел "Контакты" на главной странице).