Vai al contenuto principale

Formato di Lezione Aperto

Il Formato di Lezione Aperto è uno schema JSON standardizzato che consente ai provider di contenuto di terze parti di pubblicare il curriculum per Lessons.church. Qualsiasi organizzazione che ospita un feed in questo formato può essere aggiunto come provider esterno, rendendo il suo contenuto consultabile e riproducibile insieme alla biblioteca integrata.

Come Funziona

Un provider ospita due tipi di endpoint:

  1. Albero del Provider -- Un singolo URL che restituisce il catalogo completo di programmi, studi, lezioni e luoghi.
  2. Feed del Luogo -- Un URL per luogo, che restituisce il contenuto della lezione completo.

Quando una chiesa aggiunge l'URL del tuo provider in Lessons.church, la piattaforma recupera il tuo albero per scoprire il contenuto disponibile, quindi recupera i singoli feed del luogo su richiesta.

Albero del Provider

L'URL del tuo provider deve restituire un oggetto JSON con questa struttura:

{
"programs": [
{
"id": "program-1",
"name": "Vangelo di Marco",
"slug": "gospel-of-mark",
"image": "https://example.com/images/mark.jpg",
"about": "Uno studio di 12 settimane del Vangelo di Marco.",
"studies": [
{
"id": "study-1",
"name": "L'Inizio",
"slug": "the-beginning",
"image": "https://example.com/images/study1.jpg",
"lessons": [
{
"id": "lesson-1",
"name": "Il Battesimo di Gesù",
"slug": "baptism-of-jesus",
"title": "Il Battesimo di Gesù",
"image": "https://example.com/images/lesson1.jpg",
"description": "Un'introduzione al ministero di Gesù.",
"bottomLine": "Dio mantiene le Sue promesse.",
"verse": "Genesi 9:13 — Ho posto l'arcobaleno nelle nuvole…",
"parentQuestion": "Qual è una promessa di Dio che Dio ha mantenuto nella nostra famiglia?",
"parentNote": "Pregate insieme ringraziando Dio per aver mantenuto le Sue promesse.",
"venues": [
{
"id": "venue-1",
"name": "Bambini",
"apiUrl": "https://example.com/feed/venues/venue-1"
},
{
"id": "venue-2",
"name": "Adulti",
"apiUrl": "https://example.com/feed/venues/venue-2"
}
]
}
]
}
]
}
]
}

Campi dell'Albero

CampoTipoDescrizione
programs[].idstringIdentificatore unico del programma
programs[].namestringNome visualizzato
programs[].slugstringNome adatto all'URL
programs[].imagestringURL dell'immagine del programma (facoltativo)
programs[].aboutstringDescrizione (facoltativo)
studies[].idstringIdentificatore unico dello studio
studies[].namestringNome visualizzato
studies[].slugstringNome adatto all'URL
lessons[].idstringIdentificatore unico della lezione
lessons[].namestringNome visualizzato
lessons[].slugstringNome adatto all'URL
lessons[].titlestringTitolo completo
lessons[].imagestringURL dell'immagine della lezione (facoltativo)
lessons[].descriptionstringRiepilogo della lezione (facoltativo)
lessons[].bottomLinestringPresa a casa per i genitori su una frase (facoltativo)
lessons[].versestringRiferimento del versetto della memoria e testo breve (facoltativo)
lessons[].parentQuestionstringUna domanda per i genitori (facoltativo)
lessons[].parentNotestringNota extra facoltativa per i genitori (markdown)
venues[].idstringIdentificatore unico del luogo
venues[].namestringNome del luogo (ad es. "Bambini", "Adulti", "Giovani")
venues[].apiUrlstringURL che restituisce il feed del luogo (vedi sotto)

I quattro campi di presa a casa per i genitori (bottomLine, verse, parentQuestion, parentNote) sono facoltativi sia nell'albero che nel feed del luogo.

Feed del Luogo

L'apiUrl di ogni luogo deve restituire un oggetto JSON che corrisponda a questo schema:

{
"id": "venue-1",
"name": "Bambini",
"lessonId": "lesson-1",
"lessonName": "Il Battesimo di Gesù",
"bottomLine": "Dio mantiene le Sue promesse.",
"verse": "Genesi 9:13 — Ho posto l'arcobaleno nelle nuvole…",
"parentQuestion": "Qual è una promessa di Dio che Dio ha mantenuto nella nostra famiglia?",
"parentNote": "Pregate insieme ringraziando Dio per aver mantenuto le Sue promesse.",
"sections": [
{
"id": "section-1",
"name": "Discussione di Apertura",
"sort": 1,
"materials": "Lavagna e pennarelli",
"actions": [
{
"id": "action-1",
"actionType": "text",
"content": "**Versetto Chiave:** Marco 1:9-11",
"sort": 1
}
]
}
]
}
Suggerimento

Per vedere un esempio di feed funzionante, puoi visualizzare l'albero di contenuto Lessons.church integrato su https://api.lessons.church/lessons/public/tree e recuperare qualsiasi URL di feed del luogo da esso.