Формат открытого урока

Open Lesson Format — это стандартизированная 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": "12-недельное исследование Евангелия от Марка.",
      "studies": [
        {
          "id": "study-1",
          "name": "The Beginning",
          "slug": "the-beginning",
          "lessons": [
            {
              "id": "lesson-1",
              "name": "The Baptism of Jesus",
              "venues": [
                {
                  "id": "venue-1",
                  "name": "Kids",
                  "apiUrl": "https://example.com/feed/venues/venue-1"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Канал места

Каждый URL канала места apiUrl должен возвращать объект JSON со следующей схемой:

{
  "id": "venue-1",
  "name": "Kids",
  "lessonId": "lesson-1",
  "lessonName": "The Baptism of Jesus",
  "sections": [
    {
      "id": "section-1",
      "name": "Opening Discussion",
      "sort": 1,
      "actions": [
        {
          "id": "action-1",
          "actionType": "text",
          "content": "**Key Verse:** Mark 1:9-11",
          "sort": 1
        }
      ]
    }
  ]
}

Типы действий

Тип	Цель
play	Воспроизведение медиа — видео, аудио или слайд-шоу
text	Статическое текстовое содержание
question	Вопрос обсуждения или размышления
quote	Выделенная цитата или отрывок Писания
subhead	Заголовок или разделитель в разделе

Совет

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