Ugrás a fő tartalomra

Nyitott leckeformátum

A Nyitott leckeformátum egy szabványosított JSON-séma, amely lehetővé teszi harmadik fél tartalomszolgáltatóinak, hogy tanterveket tegyenek közzé a Lessons.church számára. Bármely szervezet, amely ilyen formátumú hírcsatornát üzemeltet, külső szolgáltatóként hozzáadható, így tartalmai a beépített könyvtár mellett is böngészhetők és lejátszhatók lesznek.

Hogyan működik​

A szolgáltató kétféle végpontot üzemeltet:

  1. Szolgáltatói fa -- Egyetlen URL, amely a programok, tanulmányok, leckék és helyszínek teljes katalógusát adja vissza. Minden helyszín tartalmaz egy hírcsatorna-URL-t, amely a részletes leckeanyagra mutat.
  2. Helyszíni hírcsatorna -- Helyszínenként egy URL, amely a teljes leckeanyagot adja vissza (szakaszok, műveletek és médiafájlok).

Amikor egy gyülekezet hozzáadja a szolgáltató URL-jét a Lessons.church-ben, a platform lekéri a fát, hogy felderítse az elérhető tartalmakat, majd igény szerint egyenként lekéri a helyszíni hírcsatornákat.

Szolgáltatói fa​

A szolgáltató URL-jének ezzel a szerkezettel rendelkező JSON-objektumot kell visszaadnia:

{
"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"
}
]
}
]
}
]
}
]
}

Fa mezői​

MezőTípusLeírás
programs[].idstringEgyedi programazonosító
programs[].namestringMegjelenített név
programs[].slugstringURL-barát név
programs[].imagestringA program képének URL-je (opcionális)
programs[].aboutstringLeírás (opcionális)
studies[].idstringEgyedi tanulmányazonosító
studies[].namestringMegjelenített név
studies[].slugstringURL-barát név
studies[].imagestringA tanulmány képének URL-je (opcionális)
lessons[].idstringEgyedi leckeazonosító
lessons[].namestringMegjelenített név
lessons[].slugstringURL-barát név
lessons[].titlestringTeljes cím
lessons[].imagestringA lecke képének URL-je (opcionális)
lessons[].descriptionstringLeckeösszefoglaló (opcionális). A könyvtárat böngésző tanítók számára készült katalógusszöveg, nem a szülőknek szánt hazavihető üzenet.
lessons[].bottomLinestringEgy mondatos üzenet a szülőknek, hogy mit vihetnek haza (opcionális)
lessons[].versestringMemoritere hivatkozása és rövid szövege (opcionális)
lessons[].parentQuestionstringEgy kérdés, amelyet a szülők otthon feltehetnek (opcionális)
lessons[].parentNotestringOpcionális kiegészítő megjegyzés a szülőknek (markdown)
venues[].idstringEgyedi helyszínazonosító
venues[].namestringA helyszín neve (pl. „Kids”, „Adults”, „Youth”)
venues[].apiUrlstringAz URL, amely a helyszíni hírcsatornát adja vissza (lásd alább)

A négy szülői hazavihető mező (bottomLine, verse, parentQuestion, parentNote) mind a fán, mind a helyszíni hírcsatornán opcionális. Ha kimaradnak, üresnek tekintjük őket. Ne másold ide a description mező tartalmát.

Helyszínek ugyanannak a leckének különböző, eltérő közönségre (korcsoportok, környezetek stb.) szabott változatait jelentik.

Helyszíni hírcsatorna​

Minden helyszín apiUrl mezőjének az alábbi sémának megfelelő JSON-objektumot kell visszaadnia:

{
"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
}
]
}
]
}
]
}

Helyszíni hírcsatorna mezői​

Gyökérobjektum​

MezőTípusLeírás
idstringHelyszínazonosító
namestringA helyszín neve
lessonIdstringLeckeazonosító
lessonNamestringA lecke megjelenített neve
lessonImagestringA lecke képének URL-je
lessonDescriptionstringLeckeösszefoglaló (katalógusszöveg)
bottomLinestringEgy mondatos üzenet a szülőknek, hogy mit vihetnek haza (opcionális)
versestringMemoritere hivatkozása és rövid szövege (opcionális)
parentQuestionstringEgy kérdés, amelyet a szülők otthon feltehetnek (opcionális)
parentNotestringOpcionális kiegészítő megjegyzés a szülőknek, markdownban (opcionális)
studyNamestringA szülő tanulmány neve
studySlugstringA szülő tanulmány slugja
programNamestringA szülő program neve
programSlugstringA szülő program slugja
programAboutstringA program leírása
downloadsarrayLetölthető fájlcsomagok
sectionsarraySorrendbe rendezett leckeszakaszok

Szakasz​

MezőTípusLeírás
idstringSzakaszazonosító
namestringSzakasz címe
sortnumberMegjelenítési sorrend
materialsstringAnyagok vagy előkészítési megjegyzések (opcionális)
actionsarrayA szakaszon belüli műveletek sorrendben

Művelet​

MezőTípusLeírás
idstringMűveletazonosító
actionTypestringEzek egyike: play, text, question, quote, subhead
contentstringSzöveges tartalom vagy médiacímke
sortnumberMegjelenítési sorrend
rolestringSzerepkör neve, pl. „Leader”, „Kids” (opcionális)
roleIdstringSzerepkör-azonosító (opcionális)
filesarrayMédiafájlok a play típusú műveletekhez (opcionális)

Fájl​

MezőTípusLeírás
idstringFájlazonosító
namestringFájlnév
urlstringKözvetlen letöltési URL
streamUrlstringStreaming URL, pl. Vimeo-link (opcionális)
fileTypestringMIME-típus (pl. video/mp4, image/jpeg)
secondsnumberHang- vagy videofájl hossza másodpercben (opcionális)
bytesnumberA fájl mérete bájtban (opcionális)
thumbnailstringBélyegkép URL-je (opcionális)
loopbooleanIsmétlődjön-e a médiatartalom (opcionális, alapértelmezés szerint false)

Letöltés​

MezőTípusLeírás
namestringLetöltési csomag neve (pl. „Printable Materials”)
filesarrayA letöltési csomagban lévő fájlok (ugyanazok a mezők, mint fent a Fájl alatt)

Műveletek típusai​

TípusCélja
playMédialejátszás -- videó, hang vagy diavetítés. Tartalmaznia kell a files mezőt.
textStatikus szöveges tartalom. Támogatja a markdown-stílusú félkövér szedést (**szöveg**).
questionBeszélgetést vagy elmélkedést indító kérdés a közönség számára.
quoteKiemelt idézet vagy bibliai szakasz.
subheadCímsor vagy elválasztó egy szakaszon belül.
tipp

A hírcsatorna működését egy működő példán keresztül is megtekintheted: a beépített Lessons.church tartalomfát a https://api.lessons.church/lessons/public/tree címen találod, és innen bármely helyszíni hírcsatorna URL-jét lekérheted.