Bearer <access_token>
Access_token пользователя, который FE получает от BE после авторизации его в системе FoxReader
Версия API
Текущее значение - v1
Каталог
Идентификатор запрашиваемой книги
{
"user_id": "feurhv",
"book": {
"id": "563428_fg6",
"title": "Гарри Поттер и Тайная комната",
"description": "Вторая книга серии о юном волшебнике",
"image_url": "url", //опциональный
"author": {
"fist_name": "Джоан",
"middle_name": "Кэтлин", //опциональный
"last_name": "Роулинг",
"short_description": "Английская писательница" //опциональный
},
"publisher_name": "Поттермо паблишинг",
"publisher_year": "08.12.2015",
"pages_count": 373,
"language": "русский",
"content_url": "url" // .epub, .pdf
}
}
AWS4-HMAC-SHA256
Credential=AKIAIOSFODNN7EXAMPLE/20130524/us-east-1/s3/aws4_request, SignedHeaders=host;range;x-amz-date, Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024
Данные по авторизации FE получает от BE.
Bearer <token>
token = "jhdtd_utdtrdgf5hgvjh_67543"
Текущее значение - v1
Идентификатор потребителя API
{
"catalogue": [
{
"id": "563428_fg6",
"title": "Гарри Поттер и Тайная комната",
"description": "Вторая книга серии о юном волшебнике", //opt
"image_url": "url", //opt
"autorName": "Джоан_Кэтлин_Роулинг",
"autorShort_description": "Английская писательница", //opt
"publisher_name": "Поттермо паблишинг",
"publisher_year": "08.12.2015",
"pages_count": "373", //min
"language": "русский"
},
{
"id": "767928_аg8",
"title": "Гарри Поттер и Узник Азкабана",
"description": "Третья книга серии о юном волшебнике", //opt
"image_url": "url",
"autorName": "Джоан_Кэтлин_Роулинг",
"autorShort_description": "Английская писательница", //opt
"publisher_name": "Поттермо паблишинг",
"publisher_year": "08.12.2015",
"pages_count": "475", //min
"language": "русский"
}
]
}
Bearer <token>
token = "jhdtd_utdtrdgf5hgvjh_67543"
["url", "url"] //тип файла определяем по расширению - text: .epub, .pdf; audio: .wav, .mp3
_
_
<!-- Категория ADR: Function|Technology|Structure|Integration|Non-function|Data (см. https://confluence.mts.ru/pages/viewpage.action?pageId=375425483) -->
<!-- Границы ADR: Enterprise - если влияние на экосистему|Cluster - если влияние на Кластер|Tribe - если влияние на Трайб|Product - если влияет только на продукт -->
<!-- Описание:
- причин, побудивших принять решение
- ограничений, действовавших на момент принятия решения
- проблемы, требующей решения -->
<!-- Описание рассмотренных вариантов.
Обязательно перечислить критерии сравнения альтернатив.
Пример критериев - соответствие принятым в компании архитектурным принципам (указать конкретные релевантные принципы).
Должно быть понятно, как критерии сравнения связаны с бизнес-приоритетами и драйверами из контекста. -->
<!-- Описание выбранного решения.
Решение должно быть сформулировано чётко ("Мы используем...", "Мы не используем", а не "Желательно.." или "Предлагается...").
Должна быть понятна связь между решением и проблемой. -->
<!-- Положительные и отрицательные последствия (trade-offs). Арх. решения, которые потребуется принять как следствие принятого решения. Если решение содержит риски, то описано, как с ними планируют поступить (за счет чего снижать, почему принять).
Арх. решения, которые потребуется принять как следствие принятого решения.
Если решение содержит риски, то описано, как с ними планируют поступить (за счет чего снижать, почему принять). -->
<!-- Здесь добавлены дополнительные ссылки (либо пусто)-->
_
_
curl --location --request POST 'https://..../¶meter_5=primer_parameter_5' \
--header 'parameter_1: ....' \
--header 'parameter_2: ....' \
--data-raw '{"parameter_3": "Пример для Параметра 3",
"parameter_4": {
"parameter_4.1": "Пример для Параметра 4.1",
"parameter_4.2": 1,}
}'
_
_
Параметр
Пример: Максимальная длина 100 символов.
Если количество символов >100, то сервис возвращает ответ с кодом 400 и описанием "Максимальная длина name 100 символов"
{
"parameter_1": "Пример для Параметра 1",
"parameter_2": {
"parameter_2.1": "Пример для Параметра 2.1",
"parameter_2.2": 1,
}
}
_
_
Код