Сравнение версий

Старая версия 2

changes.mady.by.user Илья Васильев

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user Елена Аверьянова

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.
Информация

Полный перечень всех команд «Апдейтера» есть в SWAGGER-документации, которая доступна по адресу http://updaterHost:port/swagger/index.html
Текущая спецификация в JSON — swagger.json

Для взаимодействия с «Апдейтером» рекомендуем использовать SWAGGER или приложения для работы с API (например Postman, SoapUI). 
Ниже команды для консоли указаны лишь в качестве универсального примера.

Hfl

Пример SWAGGER-документации на trunk-demo

Основные команды

Описание

Команда для консоли

(в примерах умолчательный порт 3000, и запросы выполняются с сервера Апдейтера)

Авторизация

(включена если в updater.yaml задан http_auth, 

тогда к запросам добавляется -u username:password )

Получить версию «Апдейтера» и приложений.curl -X GET http://localhost:3000/info/versionвсегда доступен
Перечитать и обновить текущие файлы конфигурации приложенияcurl -X PATCH http://localhost:3000/info/config

Получить историю вызовов Апдейтера за весь период

(или N последних дней)

curl -X GET http://localhost:3000/info/history

Скачать и обновить справочник.

В примере справочника адресов factor_fias в «Факторе».

curl -X POST -d '{"dictionary":"factor_fias", "node":"factor"}' http://localhost:3000/updater/upload

-u hflabs:hflabs_key

Скачать справочник.

В примере справочника адресов factor_fias в «Факторе».

curl -X POST -d '{"dictionary":"factor_fias", "node":"factor"}' http://localhost:3000/updater/download


Добавить задачу в расписание.

В примере настройка расписания для скачивания и обновления справочника банков в «Подсказках».

curl -X POST -d '[{"task":"upload","node":"suggestions","schedule":"00 20 * * 4","dictionaries":["suggestions_bank"]}]' http://localhost:3000/schedule

Получить список задач.curl -X GET http://localhost:3000/schedule
Удалить задачу из расписания.curl -X 'DELETE' http://localhost:3000/schedule/{scheduleId}
Hfl

Нюансы:

Если у вас включена авторизация, но вы забыли указать логин/пароль или неверно их ввели, то такой запрос через curl не возвращает ошибку.

Чтобы понять что не так, повторите запрос с флагом -v и там будет сообщение про — HTTP/1.1 401 Unauthorized