Индекс потребительских цен - документация API

API

API Индекса потребительских цен (ИПЦ)

API предоставляет доступ к данным об индексе потребительских цен и позволяет производить расчеты индексации сумм.

Аутентификация

Для доступа к API необходим токен. Токен можно передавать одним из способов:

  • В заголовке запроса: X-API-Token: ваш_токен
  • В GET-параметре: ?token=ваш_токен

Endpoints

1. Получение данных ИПЦ

GET /api/public/ipc

Возвращает все данные ИПЦ

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

GET /api/public/ipc?token=ваш_токен
GET /api/public/ipc/{year}

Возвращает данные ИПЦ за указанный год

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

GET /api/public/ipc/2023?token=ваш_токен

2. Расчет индексации

GET /api/public/ipc/calculate

Расчет индексации суммы по ИПЦ

Параметры:

  • amount - исходная сумма
  • start_date - дата начала периода (YYYY-MM-DD)
  • end_date - дата окончания периода (YYYY-MM-DD)

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

GET /api/public/ipc/calculate?token=ваш_токен&amount=100000&start_date=2023-01-01&end_date=2023-12-31

Формат ответа

API возвращает данные в формате JSON.

Пример успешного ответа:

{
    "success": true,
    "data": {
        // данные ответа
    }
}

Пример ответа с ошибкой:

{
    "error": "Описание ошибки"
}

Коды ответов

  • 200 - Успешный запрос
  • 400 - Ошибка в параметрах запроса
  • 401 - Ошибка аутентификации
  • 404 - Данные не найдены
  • 500 - Внутренняя ошибка сервера