Команды клиента для Bash

Пользователи систем, имеющих в своём составе командный интерпретатор Bash, (GNU/Linux, Mac OS X и другие UNIX-подобные системы) могут использовать для работы с LUWRAIN Books комплект скриптов, предлагающий интерфейс командной строки и функционирующий поверх утилиты curl. Ссылка для его загрузки и инструкции по установке приведены на этой странице. Подготовленные скрипты можно использовать как для интерактивной работы, так и для автоматизации операций с сервисом LUWRAIN Books.

Все команды, перечисленные ниже, возвращают ответ сервера в формате JSON. Для повышения удобства интерактивной работы комплект скриптов содержит утилиту lwr-json, использующую пакет jq и дополнительно форматирующую информацию для упрощения восприятия вывода. Утилиту lwr-json можно использовать как фильтр, перенаправляя в неё вывод всех основных команд комплекта.

Также с целью ускорения работы добавлена команда lb, которая предлагает короткую форму вызова скрипта (без префикса lwr-books-) с одновременным использованием утилиты lwr-json. Например, вызов команды lwr-books-register можно заменить вызовом команды lb register.

После вызова команды lwr-books-token в домашнем каталоге пользователя сохраняется токен доступа к сервису, который автоматически используется при выполнении всех последующих операций. Таким образом, отсутствует необходимость каждый раз как-либо явно идентифицировать себя для продолжения работы. Все команды разбиты на несколько групп, отражающих разделы открытого API сервиса.

Общие команды

lwr-books-register

  • Формат вызова: lwr-books-register АДРЕС_ЭЛЕКТРОННОЙ_ПОЧТЫ ПАРОЛЬ
  • Параметры:
    • АДРЕС_ЭЛЕКТРОННОЙ_ПОЧТЫ: адрес электронной почты регистрируемого пользователя;
    • ПАРОЛЬ: желаемый пароль.

Производит регистрацию пользователя на сервере с указанным адресом электронной почты и паролем. Адрес электронной почты является основным способом идентификации пользователя. После регистрации на указанный адрес будет выслано сообщение с кодом подтверждения. Его необходимо сообщить с использованием команды lwr-books-confirm. После подтверждения учётная запись полностью готова к выполнению всех операций.

lwr-books-confirm

  • Формат вызова: lwr-books-user-confirm АДРЕС_ЭЛЕКТРОННОЙ_ПОЧТЫ КОД_ПОДТВЕРЖДЕНИЯ
  • Параметры:
    • АДРЕС_ЭЛЕКТРОННОЙ_ПОЧТЫ: адрес электронной почты пользователя, который необходимо подтвердить;
    • КОД_ПОДТВЕРЖДЕНИЯ: код подтверждения, полученный в сообщении, высланном после регистрации на указанный адрес.

Производит подтверждение адреса электронной почты и полностью активирует учётную запись. Обратите, пожалуйста, внимание, что предоставление кода подтверждения означает полное согласие владельца адреса электронной почты с правилами использования LUWRAIN Books.

lwr-books-token

Формат вызова: lwr-books-user-access-token АДРЕС_ЭЛЕКТРОННОЙ_ПОЧТЫ ПАРОЛЬ

Команды загрузки файлов

Команды для книг в работе

lwr-books-tasks

lwr-books-task-tag

lwr-books-task-remove

Команды для созданных книг

© 2012–2021 Проект LUWRAIN
Дизайн от Strash