1. Домашнє завдання №1

Table of Contents Опис проблеми Вимога на систему Опис функціональних можливостей API Goodreads API YouTube Data API v3 Сценарій роботи колективу

Опис проблеми

Головна проблема, яку ми вирішуємо, — це складність прийняття рішення щодо вибору книги. Для успішного вибору, потрібно прочитати безліч відгуків на різних вебсайтах, переглянути відеоогляди. Через брак єдиного місця, де зібрана актуальна та корисна інформація про книжки, користувачу потрібно вручну преключатись між різними вебсайтами, і на кожному з них пробувати знайти щось, що допоможе їм у прийнятті правильного рішення. Ми пропонуємо вирішення цієї проблеми - вебсайт для надання корисної інформації про книгу. Користувач зможе увести назву книги, і у відповідь отримати рейтинг книги, тираж, доступні переклади, позитивні та негативні відгуки з платформи Goodreads, посилання на YouTube відеоогляди, тощо.

Вимога на систему

Спонсор проекту (Project Sponsor)

• Устим Ганик

Бізнес потреба (Business Need)

• створення зручної системи для пошуку інформації про потрібний твір
• автоматичний збір даних одразу з кількох джерел
• полегшення формування рішення для користувача на рахунок твору (легко робити висновки про популярність книги, визнання);
• можливість отримання посилань на відгуки про твір у різних форматах та від різних людей (текст/відео, звичайні люди/книжкові блогери/знаменитості)

Бізнес вимоги (Business Requirements)

• накопичує дані про книги
• забезпечує каталог творів
• дозволяє користувачу шукати інформацію в каталозі, пов’язану з необхідною книгою за її назвою чи описом, та переглядати отримані дані:

  + рейтинг книги та кількість оглядів на Amazon та GoodReads
  + посилання на відео огляди книги на YouTube*
  + рекомендації від відомих людей*
  + наявність у книги нагород та їх перелік* 
  + кількість іноземних перекладів*

'*' - за наявності

Питання та обмеження (Special Issues or Constraints)

• реченець розробки – 17 травня 2021 року

Опис функціональних можливостей API

Goodreads API

YouTube Data API v3

Для роботи з відео-хостингом YouTube, зокрема для пошуку оглядів книг, ми плануємо використовувати YouTube Data API v3. Цей API Документація цього API доступна за посиланням: https://developers.google.com/youtube/v3/docs/?apix=true

YouTube Data API v3 вводить типи ресурсів, з якими користувач API може взаємодіяти. Деякі типи ресурсів: activity, caption, channel, video, comment, search, subscription. API може надавати такі методи для взаємодії з цими ресурсами: list, insert, update, delete та ін. Для кожного доступного методу кожного ресурсу є свій базовий URL та тип HTTP-запиту. Для роботи з API потрібен API ключ, який можна отримати у Google Developer Console. Також, деякі запити (наприклад, для видалення відео) потребують OAuth 2.0 token для авторизації, але він нам скоріш за все не знадобиться.

YouTube Data API v3 обмежує кількість запитів. Кожен запит до API коштує щонайменше один quota unit. Всього надається 10000 quota unit’ів на день. Пошуковий запит (метод list ресурсу search) коштує 100 quota unit’ів. Отже, щодня можна здійснити не більше ніж 100 запитів пошуку.

Скоріш за все нам знадобляться наступні методи та ресурси:

1. метод list ресурсу search - здійснює пошук за рядком
2. метод list ресурсу video - дозволяє отримати інформацію (назва, опис, теги та ін.) про відео.

Сценарій роботи колективу