Litres
by mtimakova

Litres

Litres
DeviceId
string optional
Authorization

Структура Access Token (JWT) до шифрования.

Object
header
Object

Заголовок JWT токена.

alg
string

Используемый алгоритм подписи.

Example:
RSA-OAEP-256
typ
string

Тип токена.

Example:
JWT
enc
string

Используемый алгоритм шифрования.

Example:
A128GCM
payload
Object

Полезная нагрузка

userId
string

Идентификатор пользователя

Книги
Получить список книг
POST /books
Получить информацию о книге
GET /books/{id}
Получить список книг
POST /books

Метод получает список книг пользователя. Доступна фильтрация через строку поиска по ключевым словам, с помощью фильтров.

Request parameters

limit
string optional
Default:
50
offset
string optional
Default:
0

Request headers

DeviceId
string optional

Request body

application/json
Object
queryString
string nullable

Поисковая строка

Example:
Атака титанов
filters
Array of filter nullable

Массив фильтров

Example: 
["NOT_STARTED", "DOWNLOADED"]
isFavorite
boolean nullable

Признак наличия книг в “Отложенное”

isArchive
boolean nullable

Признак наличия книг в “Архив”

Responses

200 BookListResponse

BookListResponse

401 401 Unauthorized

401 Unauthorized

Получить информацию о книге
GET /books/{id}

Метод используется на экране “Детальная информация о книге”.

Path variables

id
string required

Идентификатор книги

Example:
106dfefc671c11e782dd0025905a0666

Responses

200 BookInfoResponse

BookInfoResponse

401 401 Unauthorized

401 Unauthorized

404 404 Not Found

404 Not Found

filter
string
Enumeration:
NOT_STARTED
IN_PROGRESS
DONE
DOWNLOADED
NOT_DOWNLOADED
BookLightModel
Object
id
string required

Идентификатор книги

Example:
289991883
title
string required

Название книги

Example:
Generation П
author
string required

Автор

Example:
Виктор Пелевин
price
Object

NEW! Стоимость книги

value
string

Стоимость

Example:
349
currency
string required

Валюта

Example:
RUB
rate
integer required

Рейтинг

Example:
4.5
rateCount
integer required

Количество отзывов

Example:
221
bookCover
string required

Обложка книги

status
string nullable

Статус прочтения

Example:
Читаю
isDownloaded
boolean required

Признак загрузки книги на устройстве

isFavorite
boolean required

Признак наличия книги в “Избранном”

isArchived
boolean required

Признак наличия книги в “Архив”

show more
BookExtendedModel
Object
ISBN
string required
Example:
978-5-699-43306-3
publishedYear
integer required

Год издания

litresPublishedDate
string required

Дата выхода на Литрес

Example:
30 марта 2018
translatedDate
string nullable

Год перевода

Example:
2010
ageRate
string required

Возрастной рейтинг

Example:
16+
description
string nullable

Описание книги

Example:
Думаете, что детство -- самый безоблачный период? Прочтите эту книгу.
pageCount
integer required

Колиечество страниц

Example:
234
quoteCount
integer required

Количество цитат

Example:
31
seriesCount
integer required nullable

Количество серий, в которые входит книга

Example:
2
tags
Array nullable

Теги

Object
id
string required

Идентификатор тега

Example:
106dfefc671c11e782dd0025905a0666
name
string required

Название тега

Example:
Становление героя
structure
Array nullable

Оглавление

Object
name
string required

Название главы

Example:
1 глава
order
integer required

Порядок главы

Example:
1
page
integer required

Страница

Example:
10
translator
Object nullable

Переводчик

id
string required

Идентификатор автора

Example:
106dfefc671c11e782dd0025905a0666
name
string required

Имя

Example:
Наталья Холмогорова
reviews
Array

Отзывы

Max items: 5
Object
id
string required

Идентификатор отзыва

Example:
106dfefc671c11e782dd0025905a0666
authorName
string required

Имя автора

Example:
login
authorImage
string nullable

Аватар автора

Example:
106dfefc671c11e782dd0025905a0666
content
string required

Текст отзыва

Example:
Круто! 10 из 10
rate
integer required

Рейтинг

Example:
3
thumbsUp
integer required nullable

Количество лайков

Example:
15
thumbsDown
integer required nullable

Количество дизлайков

Example:
2
booksOfAuthor
Array of BookLightModel nullable

Список других книг автора

bookSeries
Array

Серии книг, в которые входит эта книга

Object
title
string required

Название серии

Example:
Интеллектуальный бестселлер
bookList
Array

Список книг, которые входят в серию

Object
book
BookLightModel
show more
200 BookListResponse

BookListResponse

Body
application/json
Object
list
Array

Список книг

All of
BookLightModel
Examples
{
    "list": [
        {
            "id": "289991883",
            "title": "Generation П",
            "author": "Виктор Пелевин",
            "price": {
                "value": "349",
                "currency": "RUB"
            },
            "rate": 4.5,
            "rateCount": 221,
            "bookCover": "",
            "status": "Читаю",
            "isDownloaded": true,
            "isFavorite": true,
            "isArchived": true
        }
    ]
}
200 BookInfoResponse

BookInfoResponse

Body
application/json
Object
data
All of required
BookLightModel
BookExtendedModel
Examples
{
    "data": {
        "id": "289991883",
        "title": "Generation П",
        "author": "Виктор Пелевин",
        "price": {
            "value": "349",
            "currency": "RUB"
        },
        "rate": 4.5,
        "rateCount": 221,
        "bookCover": "",
        "status": "Читаю",
        "isDownloaded": true,
        "isFavorite": true,
        "isArchived": true,
        "ISBN": "978-5-699-43306-3",
        "publishedYear": 1,
        "litresPublishedDate": "30 марта 2018",
        "translatedDate": "2010",
        "ageRate": "16+",
        "description": "Думаете, что детство -- самый безоблачный период? Прочтите эту книгу.",
        "pageCount": 234,
        "quoteCount": 31,
        "seriesCount": 2,
        "tags": [
            {
                "id": "106dfefc671c11e782dd0025905a0666",
                "name": "Становление героя"
            }
        ],
        "structure": [
            {
                "name": "1 глава",
                "order": 1,
                "page": 10
            }
        ],
        "translator": {
            "id": "106dfefc671c11e782dd0025905a0666",
            "name": "Наталья Холмогорова"
        },
        "reviews": [
            {
                "id": "106dfefc671c11e782dd0025905a0666",
                "authorName": "login",
                "authorImage": "106dfefc671c11e782dd0025905a0666",
                "content": "Круто! 10 из 10",
                "rate": 3,
                "thumbsUp": 15,
                "thumbsDown": 2
            }
        ],
        "booksOfAuthor": [
            {
                "id": "289991883",
                "title": "Generation П",
                "author": "Виктор Пелевин",
                "price": {
                    "value": "349",
                    "currency": "RUB"
                },
                "rate": 4.5,
                "rateCount": 221,
                "bookCover": "",
                "status": "Читаю",
                "isDownloaded": true,
                "isFavorite": true,
                "isArchived": true
            }
        ],
        "bookSeries": [
            {
                "title": "Интеллектуальный бестселлер",
                "bookList": [
                    {
                        "book": {
                            "id": "289991883",
                            "title": "Generation П",
                            "author": "Виктор Пелевин",
                            "price": {
                                "value": "349",
                                "currency": "RUB"
                            },
                            "rate": 4.5,
                            "rateCount": 221,
                            "bookCover": "",
                            "status": "Читаю",
                            "isDownloaded": true,
                            "isFavorite": true,
                            "isArchived": true
                        }
                    }
                ]
            }
        ]
    }
}
401 401 Unauthorized

401 Unauthorized

Body
application/json
Object
data
Object required
code
string required

Код ошибки.

Enumeration:
UNAUTHORIZED_ERROR
message
string required

Сообщение об ошибке.

Example:
AccessToken невалиден или просрочен.
404 404 Not Found

404 Not Found

Service Litres
Получить список книг пользователя
POST /books/user/{id}
Получить детальную информацию о книге
GET /books/{id}/detailInfo
Получить список книг пользователя
POST /books/user/{id}

Метод получения списка книг пользователя.

Path variables

id
string required

Request headers

DeviceId
string optional

Request body

Object
queryString
string nullable

Запрос из поисковой строки.

Example:
Атака титанов
filters
Array of filter nullable

Массив фильтров

Example: 
["NOT_STARTED", "DOWNLOADED"]
isFavorite
boolean nullable

Признак наличия книг в “Отложенное”

isArchive
boolean nullable

Признак наличия книг в “Архив”

Responses

200 BooksUserResponse

Список книг пользователя.

401 401 Unauthorized

401 Unauthorized

404 404 Not Found

404 Not Found

Получить детальную информацию о книге
GET /books/{id}/detailInfo

Метод получения детальной информации о книге.

Path variables

id
string required

Responses

200 BookDetailInfoResponse

Детальная информация о книге.

401 401 Unauthorized

401 Unauthorized

404 404 Not Found

404 Not Found

BookProgressScaleModel

Шкала прогресса прочтения книги в процентах.

Object
progressScale
integer nullable

Шкала прогресса в процентах.

Example:
60
200 BooksUserResponse

Список книг пользователя.

Body
Object
list
Array

Список книг пользователя.

All of
BookLightModel
BookProgressScaleModel
limit
string required

Количество возвращаемых элементов в массиве list.

Example:
50
offset
string required

Смещение выборки.

Example:
0
total
string required

Количество элементов в выборке.

Example:
1000
Examples
{
    "list": [
        {
            "id": "289991883",
            "title": "Generation П",
            "author": "Виктор Пелевин",
            "price": {
                "value": "349",
                "currency": "RUB"
            },
            "rate": 4.5,
            "rateCount": 221,
            "bookCover": "",
            "status": "Читаю",
            "isDownloaded": true,
            "isFavorite": true,
            "isArchived": true,
            "progressScale": 60
        }
    ],
    "limit": "50",
    "offset": "0",
    "total": "1000"
}
200 BookDetailInfoResponse

Детальная информация о книге.

Body
All of
BookLightModel
BookExtendedModel
Examples
{
    "id": "289991883",
    "title": "Generation П",
    "author": "Виктор Пелевин",
    "price": {
        "value": "349",
        "currency": "RUB"
    },
    "rate": 4.5,
    "rateCount": 221,
    "bookCover": "",
    "status": "Читаю",
    "isDownloaded": true,
    "isFavorite": true,
    "isArchived": true,
    "ISBN": "978-5-699-43306-3",
    "publishedYear": 1,
    "litresPublishedDate": "30 марта 2018",
    "translatedDate": "2010",
    "ageRate": "16+",
    "description": "Думаете, что детство -- самый безоблачный период? Прочтите эту книгу.",
    "pageCount": 234,
    "quoteCount": 31,
    "seriesCount": 2,
    "tags": [
        {
            "id": "106dfefc671c11e782dd0025905a0666",
            "name": "Становление героя"
        }
    ],
    "structure": [
        {
            "name": "1 глава",
            "order": 1,
            "page": 10
        }
    ],
    "translator": {
        "id": "106dfefc671c11e782dd0025905a0666",
        "name": "Наталья Холмогорова"
    },
    "reviews": [
        {
            "id": "106dfefc671c11e782dd0025905a0666",
            "authorName": "login",
            "authorImage": "106dfefc671c11e782dd0025905a0666",
            "content": "Круто! 10 из 10",
            "rate": 3,
            "thumbsUp": 15,
            "thumbsDown": 2
        }
    ],
    "booksOfAuthor": [
        {
            "id": "289991883",
            "title": "Generation П",
            "author": "Виктор Пелевин",
            "price": {
                "value": "349",
                "currency": "RUB"
            },
            "rate": 4.5,
            "rateCount": 221,
            "bookCover": "",
            "status": "Читаю",
            "isDownloaded": true,
            "isFavorite": true,
            "isArchived": true
        }
    ],
    "bookSeries": [
        {
            "title": "Интеллектуальный бестселлер",
            "bookList": [
                {
                    "book": {
                        "id": "289991883",
                        "title": "Generation П",
                        "author": "Виктор Пелевин",
                        "price": {
                            "value": "349",
                            "currency": "RUB"
                        },
                        "rate": 4.5,
                        "rateCount": 221,
                        "bookCover": "",
                        "status": "Читаю",
                        "isDownloaded": true,
                        "isFavorite": true,
                        "isArchived": true
                    }
                }
            ]
        }
    ]
}