Постачальник вмісту FreePlay
FreePlay — це медіаплеєр ChurchApps для потокового відтворення уроків та іншого відеоконтенту на телефонах, планшетах і телевізорах. Якщо у вас є бібліотека уроків і ви хочете зробити її доступною у FreePlay, цей посібник містить усе, що вам потрібно надати.
Брендинг
Перш ніж розпочати інтеграцію, нам потрібно:
- Логотип -- Зображення логотипу у співвідношенні сторін 16:9 (використовується для карток постачальників в інтерфейсі FreePlay)
- Назва бренду -- Бажана назва вашої організації, яка відображатиметься у FreePlay
Кінцеві точки API
FreePlay взаємодіє з вашим сервісом через невеликий набір кінцевих точок REST. Ми пишемо окремий адаптер для кожного постачальника, тому точна структура URL може бути гнучкою, але наведена нижче інформація є тим, що нам потрібно.
Автентифікація
Виберіть модель, яка відповідає вашому контенту:
| Модель | Коли використовувати | Що нам потрібно |
|---|---|---|
| Немає | Публічний контент, вхід не потрібен | Нічого -- ми звертаємося до ваших кінцевих точок каталогу напряму |
| OAuth (PKCE) | Вхід через веб/мобільні пристрої | URL авторизації, кінцева точка обміну токенами, ідентифікатор клієнта, області доступу (scopes) |
| Device Flow | Бажаний варіант для застосунків на телевізорах (користувач вводить короткий код на своєму телефоні) | Кінцева точка авторизації пристрою, кінцева точка опитування токенів, ідентифікатор клієнта |
Якщо ваш контент потребує автентифікації, кінцева точка автентифікації повертає токен користувача, який FreePlay передає кінцевим точкам перегляду та уроків для авторизації доступу.
Перегляд / Каталог
Кінцева точка (або набір кінцевих точок), що повертає дерево папок з усіма доступними уроками.
- Це може бути один запит, що повертає все дерево, або кілька запитів, де кожен повертає один рівень, коли користувач переходить глибше.
- Кожен елемент дерева має містити:
| Поле | Обов'язкове | Опис |
|---|---|---|
id | Так | Унікальний ідентифікатор папки |
name | Так | Назва папки для відображення |
thumbnail | Рекомендовано | URL мініатюри у співвідношенні 16:9 |
Плейлист уроку
Кінцева точка, що повертає плейлист медіафайлів для одного уроку.
Кожен елемент плейлиста має містити:
| Поле | Обов'язкове | Опис |
|---|---|---|
title | Так | Назва медіаелемента для відображення |
mediaType | Так | video або image |
url | Так | Пряме посилання для завантаження файлу (див. Медіаформати нижче) |
thumbnail | Рекомендовано | Зображення-мініатюра для елемента |
duration | Рекомендовано | Тривалість у секундах (для відео) |
Медіаформати
FreePlay завантажує файли безпосередньо, тому кожен медіаелемент повинен мати пряме посилання (без вбудованих плеєрів чи перенаправлень на сторінки).
| Тип | Прийнятні формати |
|---|---|
| Відео | MP4 (обов'язково для відтворення на пристроях Apple та Android) |
| Зображення | JPG, PNG або GIF |
Примітки
- REST API, що повертає JSON, є типовим шаблоном інтеграції, але оскільки ми пишемо окремий адаптер для кожного постачальника, ми можемо працювати практично з будь-яким форматом API.
- Якщо ви зацікавлені в тому, щоб стати постачальником вмісту для FreePlay, зв'яжіться з нами в Slack або створіть issue на GitHub.