Перейти до основного вмісту

Формат відкритого уроку

Формат відкритого уроку — це стандартизована схема JSON, яка дає змогу стороннім постачальникам контенту публікувати навчальні програми для Lessons.church. Будь-яку організацію, яка розміщує стрічку в цьому форматі, можна додати як зовнішнього постачальника. Її контент буде доступний для перегляду й відтворення поряд із вбудованою бібліотекою.

Як це працює​

Постачальник розміщує два типи кінцевих точок:

  1. Дерево постачальника -- одна URL-адреса, яка повертає повний каталог програм, курсів, уроків і локацій. Кожна локація містить URL-адресу стрічки, що веде до детального вмісту уроку.
  2. Стрічка локації -- по одній URL-адресі на кожну локацію, яка повертає повний вміст уроку (розділи, дії та медіафайли).

Коли церква додає URL-адресу вашого постачальника в Lessons.church, платформа завантажує ваше дерево, щоб знайти доступний контент, а потім завантажує стрічки окремих локацій за запитом.

Дерево постачальника​

URL-адреса вашого постачальника має повертати об'єкт JSON із такою структурою:

{
"programs": [
{
"id": "program-1",
"name": "Gospel of Mark",
"slug": "gospel-of-mark",
"image": "https://example.com/images/mark.jpg",
"about": "A 12-week study through the Gospel of Mark.",
"studies": [
{
"id": "study-1",
"name": "The Beginning",
"slug": "the-beginning",
"image": "https://example.com/images/study1.jpg",
"lessons": [
{
"id": "lesson-1",
"name": "The Baptism of Jesus",
"slug": "baptism-of-jesus",
"title": "The Baptism of Jesus",
"image": "https://example.com/images/lesson1.jpg",
"description": "An introduction to Jesus' ministry.",
"bottomLine": "God keeps His promises.",
"verse": "Genesis 9:13 — I have set my rainbow in the clouds…",
"parentQuestion": "What is one promise God has kept in our family?",
"parentNote": "Pray together thanking God for keeping His promises.",
"venues": [
{
"id": "venue-1",
"name": "Kids",
"apiUrl": "https://example.com/feed/venues/venue-1"
},
{
"id": "venue-2",
"name": "Adults",
"apiUrl": "https://example.com/feed/venues/venue-2"
}
]
}
]
}
]
}
]
}

Поля дерева​

ПолеТипОпис
programs[].idрядокУнікальний ідентифікатор програми
programs[].nameрядокНазва для відображення
programs[].slugрядокНазва, придатна для URL
programs[].imageрядокURL-адреса зображення програми (необов'язково)
programs[].aboutрядокОпис (необов'язково)
studies[].idрядокУнікальний ідентифікатор курсу
studies[].nameрядокНазва для відображення
studies[].slugрядокНазва, придатна для URL
studies[].imageрядокURL-адреса зображення курсу (необов'язково)
lessons[].idрядокУнікальний ідентифікатор уроку
lessons[].nameрядокНазва для відображення
lessons[].slugрядокНазва, придатна для URL
lessons[].titleрядокПовна назва
lessons[].imageрядокURL-адреса зображення уроку (необов'язково)
lessons[].descriptionрядокКороткий опис уроку (необов'язково). Каталожний текст для вчителів, які переглядають бібліотеку, а не домашнє завдання для батьків.
lessons[].bottomLineрядокОдин речення з головною думкою для батьків, яку вони забирають додому (необов'язково)
lessons[].verseрядокПосилання на вірш для запам'ятовування та короткий текст (необов'язково)
lessons[].parentQuestionрядокОдне запитання, яке батьки можуть поставити вдома (необов'язково)
lessons[].parentNoteрядокДодаткова примітка для батьків (необов'язково, у форматі markdown)
venues[].idрядокУнікальний ідентифікатор локації
venues[].nameрядокНазва локації (наприклад, "Kids", "Adults", "Youth")
venues[].apiUrlрядокURL-адреса, що повертає стрічку локації (див. нижче)

Чотири поля з головною думкою для батьків (bottomLine, verse, parentQuestion, parentNote) є необов'язковими як у дереві, так і в стрічці локації. Якщо їх немає, вони вважаються порожніми. Не копіюйте description у ці поля.

Локації відображають різні версії того самого уроку, адаптовані для різних аудиторій (вікових груп, умов тощо).

Стрічка локації​

Кожна apiUrl локації має повертати об'єкт JSON, який відповідає цій схемі:

{
"id": "venue-1",
"name": "Kids",
"lessonId": "lesson-1",
"lessonName": "The Baptism of Jesus",
"lessonImage": "https://example.com/images/lesson1.jpg",
"lessonDescription": "An introduction to Jesus' ministry.",
"bottomLine": "God keeps His promises.",
"verse": "Genesis 9:13 — I have set my rainbow in the clouds…",
"parentQuestion": "What is one promise God has kept in our family?",
"parentNote": "Pray together thanking God for keeping His promises.",
"studyName": "The Beginning",
"studySlug": "the-beginning",
"programName": "Gospel of Mark",
"programSlug": "gospel-of-mark",
"programAbout": "A 12-week study through the Gospel of Mark.",
"downloads": [],
"sections": [
{
"id": "section-1",
"name": "Opening Discussion",
"sort": 1,
"materials": "Whiteboard and markers",
"actions": [
{
"id": "action-1",
"actionType": "text",
"content": "**Key Verse:** Mark 1:9-11",
"sort": 1
},
{
"id": "action-2",
"actionType": "question",
"content": "What do you know about baptism?",
"sort": 2,
"role": "Leader"
},
{
"id": "action-3",
"actionType": "play",
"content": "Intro Video",
"sort": 3,
"files": [
{
"id": "file-1",
"name": "intro-video.mp4",
"url": "https://example.com/media/intro.mp4",
"streamUrl": "https://vimeo.com/123456789",
"fileType": "video/mp4",
"seconds": 180,
"bytes": 52428800,
"thumbnail": "https://example.com/media/intro-thumb.jpg",
"loop": false
}
]
}
]
}
]
}

Поля стрічки локації​

Кореневий об'єкт​

ПолеТипОпис
idрядокІдентифікатор локації
nameрядокНазва локації
lessonIdрядокІдентифікатор уроку
lessonNameрядокНазва уроку для відображення
lessonImageрядокURL-адреса зображення уроку
lessonDescriptionрядокКороткий опис уроку (каталожний текст)
bottomLineрядокОдин речення з головною думкою для батьків (необов'язково)
verseрядокПосилання на вірш для запам'ятовування та короткий текст (необов'язково)
parentQuestionрядокОдне запитання, яке батьки можуть поставити вдома (необов'язково)
parentNoteрядокДодаткова примітка для батьків, у форматі markdown (необов'язково)
studyNameрядокНазва батьківського курсу
studySlugрядокSlug батьківського курсу
programNameрядокНазва батьківської програми
programSlugрядокSlug батьківської програми
programAboutрядокОпис програми
downloadsмасивПакети файлів для завантаження
sectionsмасивУпорядковані розділи уроку

Розділ​

ПолеТипОпис
idрядокІдентифікатор розділу
nameрядокНазва розділу
sortчислоПорядок відображення
materialsрядокМатеріали або примітки щодо підготовки (необов'язково)
actionsмасивУпорядковані дії в межах цього розділу

Дія​

ПолеТипОпис
idрядокІдентифікатор дії
actionTypeрядокОдне з: play, text, question, quote, subhead
contentрядокТекстовий вміст або мітка медіа
sortчислоПорядок відображення
roleрядокНазва ролі, наприклад "Leader", "Kids" (необов'язково)
roleIdрядокІдентифікатор ролі (необов'язково)
filesмасивМедіафайли для дій play (необов'язково)

Файл​

ПолеТипОпис
idрядокІдентифікатор файлу
nameрядокНазва файлу
urlрядокПряма URL-адреса для завантаження
streamUrlрядокURL для потокового відтворення, наприклад посилання на Vimeo (необов'язково)
fileTypeрядокMIME-тип (наприклад, video/mp4, image/jpeg)
secondsчислоТривалість аудіо- або відеофайлу в секундах (необов'язково)
bytesчислоРозмір файлу в байтах (необов'язково)
thumbnailрядокURL-адреса мініатюри (необов'язково)
loopлогічнийЧи має медіа повторюватися (необов'язково, за замовчуванням false)

Завантаження​

ПолеТипОпис
nameрядокНазва пакета для завантаження (наприклад, "Printable Materials")
filesмасивФайли в цьому пакеті завантаження (ті самі поля, що й у File вище)

Типи дій​

ТипПризначення
playВідтворення медіа -- відео, аудіо або слайд-шоу. Має містити files.
textСтатичний текстовий вміст. Підтримує жирний шрифт у стилі markdown (**текст**).
questionЗапитання для обговорення або роздумів для аудиторії.
quoteВиділена цитата або уривок з Писання.
subheadЗаголовок або роздільник усередині розділу.
поради

Щоб побачити робочий приклад стрічки, можна переглянути вбудоване дерево контенту Lessons.church за адресою https://api.lessons.church/lessons/public/tree і відкрити будь-яку URL-адресу стрічки локації з нього.