Lewati ke konten utama

Format Pelajaran Terbuka

Format Pelajaran Terbuka adalah skema JSON standar yang memungkinkan penyedia konten pihak ketiga menerbitkan kurikulum untuk Lessons.church. Organisasi mana pun yang menyediakan feed dalam format ini dapat ditambahkan sebagai penyedia eksternal, sehingga kontennya dapat dijelajahi dan diputar bersama pustaka bawaan.

Cara Kerjanya​

Penyedia menyediakan dua jenis endpoint:

  1. Pohon Penyedia -- Satu URL yang mengembalikan seluruh katalog program, studi, pelajaran, dan venue. Setiap venue menyertakan URL feed yang mengarah ke konten pelajaran yang terperinci.
  2. Feed Venue -- Satu URL untuk setiap venue, yang mengembalikan seluruh konten pelajaran (bagian, aksi, dan file media).

Ketika sebuah gereja menambahkan URL penyedia Anda di Lessons.church, platform akan mengambil pohon Anda untuk menemukan konten yang tersedia, lalu mengambil feed setiap venue sesuai kebutuhan.

Pohon Penyedia​

URL penyedia Anda harus mengembalikan objek JSON dengan struktur berikut:

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

Kolom Pohon​

KolomTipeDeskripsi
programs[].idstringPengidentifikasi program yang unik
programs[].namestringNama tampilan
programs[].slugstringNama yang ramah URL
programs[].imagestringURL gambar program (opsional)
programs[].aboutstringDeskripsi (opsional)
studies[].idstringPengidentifikasi studi yang unik
studies[].namestringNama tampilan
studies[].slugstringNama yang ramah URL
studies[].imagestringURL gambar studi (opsional)
lessons[].idstringPengidentifikasi pelajaran yang unik
lessons[].namestringNama tampilan
lessons[].slugstringNama yang ramah URL
lessons[].titlestringJudul lengkap
lessons[].imagestringURL gambar pelajaran (opsional)
lessons[].descriptionstringRingkasan pelajaran (opsional). Teks katalog untuk guru yang menjelajahi pustaka, bukan rangkuman untuk orang tua.
lessons[].bottomLinestringIntisari satu kalimat untuk dibawa pulang orang tua (opsional)
lessons[].versestringReferensi ayat hafalan dan teks singkatnya (opsional)
lessons[].parentQuestionstringSatu pertanyaan untuk ditanyakan orang tua di rumah (opsional)
lessons[].parentNotestringCatatan tambahan opsional untuk orang tua (markdown)
venues[].idstringPengidentifikasi venue yang unik
venues[].namestringNama venue (misalnya "Kids", "Adults", "Youth")
venues[].apiUrlstringURL yang mengembalikan feed venue (lihat di bawah)

Keempat kolom intisari untuk orang tua (bottomLine, verse, parentQuestion, parentNote) bersifat opsional, baik pada pohon maupun pada feed venue. Jika dihilangkan, nilainya dianggap kosong. Jangan menyalin description ke dalam kolom-kolom tersebut.

Venue mewakili versi berbeda dari pelajaran yang sama, yang disesuaikan untuk audiens yang berbeda (kelompok usia, suasana, dan sebagainya).

Feed Venue​

apiUrl setiap venue harus mengembalikan objek JSON yang sesuai dengan skema ini:

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

Kolom Feed Venue​

Objek Akar​

KolomTipeDeskripsi
idstringPengidentifikasi venue
namestringNama venue
lessonIdstringPengidentifikasi pelajaran
lessonNamestringNama tampilan pelajaran
lessonImagestringURL gambar pelajaran
lessonDescriptionstringRingkasan pelajaran (teks katalog)
bottomLinestringIntisari satu kalimat untuk dibawa pulang orang tua (opsional)
versestringReferensi ayat hafalan dan teks singkatnya (opsional)
parentQuestionstringSatu pertanyaan untuk ditanyakan orang tua di rumah (opsional)
parentNotestringCatatan tambahan opsional untuk orang tua, dalam markdown (opsional)
studyNamestringNama studi induk
studySlugstringSlug studi induk
programNamestringNama program induk
programSlugstringSlug program induk
programAboutstringDeskripsi program
downloadsarrayKumpulan file yang dapat diunduh
sectionsarrayBagian pelajaran yang berurutan

Bagian​

KolomTipeDeskripsi
idstringPengidentifikasi bagian
namestringJudul bagian
sortnumberUrutan tampilan
materialsstringCatatan bahan atau persiapan (opsional)
actionsarrayAksi yang berurutan dalam bagian ini

Aksi​

KolomTipeDeskripsi
idstringPengidentifikasi aksi
actionTypestringSalah satu dari: play, text, question, quote, subhead
contentstringKonten teks atau label media
sortnumberUrutan tampilan
rolestringNama peran, misalnya "Leader", "Kids" (opsional)
roleIdstringPengidentifikasi peran (opsional)
filesarrayFile media untuk aksi play (opsional)

File​

KolomTipeDeskripsi
idstringPengidentifikasi file
namestringNama file
urlstringURL unduhan langsung
streamUrlstringURL streaming, misalnya tautan Vimeo (opsional)
fileTypestringTipe MIME (misalnya video/mp4, image/jpeg)
secondsnumberDurasi dalam detik untuk audio/video (opsional)
bytesnumberUkuran file dalam byte (opsional)
thumbnailstringURL gambar miniatur (opsional)
loopbooleanApakah media harus diulang (opsional, default false)

Unduhan​

KolomTipeDeskripsi
namestringNama kumpulan unduhan (misalnya "Printable Materials")
filesarrayFile dalam kumpulan unduhan ini (kolom yang sama dengan File di atas)

Jenis Aksi​

JenisTujuan
playPemutaran media -- video, audio, atau slideshow. Harus menyertakan files.
textKonten teks statis. Mendukung cetak tebal gaya markdown (**teks**).
questionPertanyaan diskusi atau refleksi untuk audiens.
quoteKutipan atau bagian Kitab Suci yang disorot.
subheadJudul atau pemisah dalam sebuah bagian.
tip

Untuk melihat contoh feed yang berfungsi, Anda dapat membuka pohon konten bawaan Lessons.church di https://api.lessons.church/lessons/public/tree dan mengambil URL feed venue mana pun dari sana.