Секция /v1/repo/

repo/create

Запрос /v1/repo/create/ выполняет создание аудиокниги в репозитории в виде, пригодном для скачивания. Идентификатор книги, полученный после выполнения этого запроса, является идентификатором в секции /v1/books/, к которому могут обращаться все пользователи, для кого предназначена опубликованная книга. ППосле создания книги необходимо задать информацию о ней и загрузить аудиофайлы.

  • Адрес запроса: https://books.luwrain.org/v1/repo/create/
  • Метод: GET
  • Параметры:
    • atoken: токен доступа
  • Формат ответа: JSON
  • Поля ответа:
    • type: код ответа, принимающий следующие значения:
      • OK: новая аудиокнига в репозитории создана
      • NO_VALID_ACCESS_TOKEN: не предоставлен или предоставлен неверный токен доступа
    • book: идентификатор книги в репозитории

repo/upload

Запрос /v1/repo/upload/ позволяет загрузить материалы аудиокниги в репозитории. Выполнение этой операции только создаёт запись для загрузки файла с предоставлением её идентификатора, при этом непосредственную загрузку необходимо выполнить при помощи дополнительного запроса, описанным в секции /v1/upload/, передав ему полученный идентификатор. Все необходимые обновления в материалах аудиокниги и её атрибутах будут произведены после полного завершения загрузки файла.

Загруженный файл может содержать любые материалы, даже если они были созданы без использования инструментария сервиса LUWRAIN Books. Файлы в ZIP-архивах могут быть удалены, если их содержимое не распознано как аудиозапись в формате MP3 или как текстовый файл. Загрузку файлов аудиокниги может выполнять только её владелец.

  • Адрес запроса: https://books.luwrain.org/v1/repo/upload/
  • Метод: GET
  • Параметры:
    • atoken: токен доступа
    • book: идентификатор аудиокниги в репозитории, может быть получен при помощи запроса /v1/repo/create/
    • format: идентификатор формат материалов аудиокниги, принимающий следующие значения:
      • mp3-zip: загруженный файл должен быть ZIP-архивом с файлами в формате MP3.
  • Формат ответа: JSON
  • Поля ответа:
    • type: код ответа, принимающий следующие значения:
      • OK: запись о загрузке файла создана
      • NO_VALID_ACCESS_TOKEN: не предоставлен или предоставлен неверный токен доступа
    • upload: идентификатор загрузки, который необходимо использовать для последующего запроса /v1/upload/
© 2012–2021 Проект LUWRAIN
Дизайн от Strash