Naar hoofdinhoud gaan

Inhoudeindpunten

De Inhoudsmodule beheert websitepagina's, secties, elementen, blokken, preken, afspeellijsten, streaming-services, evenementen, samengestelde kalenders, bestanden, galerijen, Bijbelvertalingen en verszoekopdrachten, nummers, arrangementen, globale stijlen, stockfoto's en instellingen. Dit is de grootste module in de API en drijft de CMS, media/streaming, aanbidding planning en Bijbelfeatures in alle ChurchApps-applicaties.

Basispad: /content

Pagina's

Basispad: /content/pages

MethodePadVerwijzingToestemmingBeschrijving
GET/:churchId/tree?url=&id=OpenbaarLaad volledige pagina boom (secties, elementen, blokken) per URL of ID. Verwijdert interne ID's wanneer opgehaald per URL
GET/:idJWTEen pagina op ID opvragen
GET/JWTLijst alle pagina's voor de kerk
POST/duplicate/:idJWTContent.EditDupliceer een pagina met alle secties en elementen
POST/temp/aiJWTContent.EditSla een door AI gegenereerde pagina op (pagina, secties en elementen in één aanroep)
POST/JWTContent.EditPagina's maken of bijwerken (batch)
DELETE/:idJWTContent.EditEen pagina verwijderen

Voorbeeld: Pagina Boom laden

GET /content/pages/abc-church-id/tree?url=/about
{
"name": "About",
"url": "/about",
"sections": [
{
"background": "#FFFFFF",
"textColor": "dark",
"elements": [
{ "elementType": "textWithPhoto", "answers": { "text": "Welcome" } }
]
}
]
}

Secties

Basispad: /content/sections

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTEen sectie op ID opvragen
POST/duplicate/:id?convertToBlock=JWTContent.EditDupliceer een sectie of converteer deze naar een herbruikbaar blok
POST/JWTContent.EditSecties maken of bijwerken (batch). Sorteer volgorde automatisch
DELETE/:idJWTContent.EditEen sectie verwijderen (sorteervolgorde automatisch bijwerken)

Elementen

Basispad: /content/elements

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTEen element op ID opvragen
POST/duplicate/:idJWTContent.EditDupliceer een element met alle onderliggende elementen
POST/JWTContent.EditElementen maken of bijwerken (batch). Beheer automatisch rijkolommen en carrouselladen
DELETE/:idJWTContent.EditEen element verwijderen

Blokken

Basispad: /content/blocks

Breidt standaard CRUD uit (GET /:id, GET /, POST /, DELETE /:id van basisklasse met Content.Edit toestemming voor schrijfbewerkingen).

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTEen blok op ID opvragen
GET/JWTLijst alle blokken
GET/:churchId/tree/:idOpenbaarLaad volledige blokboom met secties en elementen
GET/blockType/:blockTypeJWTLaad blokken per type (bijv. footerBlock, elementBlock)
GET/public/footer/:churchIdOpenbaarLaad voettekstblokboom voor een kerk
POST/JWTContent.EditBlokken maken of bijwerken
DELETE/:idJWTContent.EditEen blok verwijderen

Koppelingen

Basispad: /content/links

Breidt standaard CRUD uit (GET /:id, GET /, POST /, DELETE /:id van basisklasse met Content.Edit toestemming voor schrijfbewerkingen).

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTEen koppeling op ID opvragen
GET/JWTLijst alle koppelingen. Optionele ?category= filter. Automatisch gesorteerd na opslaan
GET/church/:churchId/filtered?category=JWTLaad koppelingen gefilterd op zichtbaarheid (iedereen, bezoekers, leden, personeel, groepen)
GET/church/:churchId?category=OpenbaarLaad koppelingen voor een kerk per categorie (openbaar)
POST/JWTContent.EditKoppelingen maken of bijwerken (batch). Automatisch sorteren per categorie
DELETE/:idJWTContent.EditEen koppeling verwijderen

Globale stijlen

Basispad: /content/globalStyles

Breidt standaard CRUD uit (POST /, DELETE /:id van basisklasse met Content.Edit toestemming voor schrijfbewerkingen).

MethodePadVerwijzingToestemmingBeschrijving
GET/church/:churchIdOpenbaarLaad globale stijlen voor een kerk (retourneert standaarden als er geen zijn ingesteld)
GET/JWTLaad globale stijlen voor de geverifieerde kerk
POST/JWTContent.EditGlobale stijlen maken of bijwerken
DELETE/:idJWTContent.EditGlobale stijlen verwijderen

Paginageschiedenis

Basispad: /content/pageHistory

MethodePadVerwijzingToestemmingBeschrijving
GET/page/:pageIdJWTContent.EditLijst geschiedenisitems voor een pagina
GET/block/:blockIdJWTContent.EditLijst geschiedenisitems voor een blok
GET/:idJWTContent.EditHaal geschiedenisitem op ID
POST/JWTContent.EditSla pagina/blok momentopname op. Schoon periodiek items ouder dan 30 dagen op
POST/restore/:idJWTContent.EditHerstel een pagina/blok uit momentopname (verwijdert huidige inhoud en herstelt uit momentopname)
POST/restoreSnapshotJWTContent.EditHerstel vanuit inline momentopname object. Body: { pageId, blockId, snapshot }

Preken

Basispad: /content/sermons

MethodePadVerwijzingToestemmingBeschrijving
GET/public/freeshowSampleJWTHaal voorbeeld FreeShow afspeellijst structuur
GET/public/tvWrapper/:churchIdJWTHaal TV app wrapper met preek, les en FreeShow bronnen
GET/public/tvFeed/:churchId/:sermonIdOpenbaarHaal enkele preek als TV feed afspeellijst
GET/public/tvFeed/:churchIdOpenbaarHaal alle openbare afspeellijsten/preken als TV feed
GET/public/:churchIdOpenbaarLijst alle openbare preken voor een kerk
GET/timeline?sermonIds=JWTLaad tijdlijngegevens voor preken
GET/lookup?videoType=&videoData=OpenbaarZoek predikantmetagegevens op vanuit YouTube of Vimeo
GET/socialSuggestions?youtubeVideoId=JWTGenereer AI-suggesties voor social media berichten vanuit preekondertitels
GET/outline?url=&title=&author=JWTGenereer AI-lesoverzicht uit URL
GET/youtubeImport/:channelIdJWTImporteer video's vanuit een YouTube-kanaal
GET/vimeoImport/:channelIdJWTImporteer video's vanuit een Vimeo-kanaal
GET/:idJWTHaal preek op ID
GET/JWTLijst alle preken
POST/JWTStreamingServices.EditPreken maken of bijwerken (batch, ondersteunt base64 miniatuuropload)
DELETE/:idJWTStreamingServices.EditEen preek verwijderen

Voorbeeld: YouTube-preek opzoeken

GET /content/sermons/lookup?videoType=youtube&videoData=dQw4w9WgXcQ
{
"title": "Sunday Service - Faith in Action",
"description": "Pastor John speaks about faith...",
"thumbnail": "https://img.youtube.com/vi/dQw4w9WgXcQ/default.jpg",
"duration": 2400,
"publishDate": "2025-01-15T10:00:00Z"
}

Afspeellijsten

Basispad: /content/playlists

Breidt standaard CRUD uit (GET /:id, GET /, DELETE /:id van basisklasse met StreamingServices.Edit toestemming voor schrijfbewerkingen).

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTHaal afspeellijst op ID
GET/JWTLijst alle afspeellijsten
GET/public/:churchIdOpenbaarLijst alle openbare afspeellijsten voor een kerk
POST/JWTStreamingServices.EditAfspeellijsten maken of bijwerken (batch, ondersteunt base64 miniatuuropload)
DELETE/:idJWTStreamingServices.EditEen afspeellijst verwijderen

Streaming-services

Basispad: /content/streamingServices

MethodePadVerwijzingToestemmingBeschrijving
GET/:id/hostChatJWTChat.HostHaal versleutelde host chatkamarID voor een service
GET/JWTLijst alle streaming-services. Schoon automatisch verouderde niet-terugkerende services op en vervorder terugkerende
POST/JWTStreamingServices.EditStreaming-services maken of bijwerken (batch)
DELETE/:idJWTStreamingServices.EditEen streaming-service verwijderen (wist ook geblokkeerde IP's)

Evenementen

Basispad: /content/events

MethodePadVerwijzingToestemmingBeschrijving
GET/timeline/group/:groupId?eventIds=JWTLaad tijdlijn evenementen voor een groep
GET/timeline?eventIds=JWTLaad tijdlijn evenementen voor de groepen van de huidige gebruiker
GET/subscribe?churchId=&groupId=&curatedCalendarId=OpenbaarAbonneer op evenementen als ICS kalender feed
GET/group/:groupIdJWTHaal evenementen voor een groep (inclusief uitzonderingsdata)
GET/public/group/:churchId/:groupIdOpenbaarHaal openbare evenementen voor een groep
GET/:idJWTHaal evenement op ID
POST/JWTEvenementen maken of bijwerken (batch)
DELETE/:idJWTContent.EditEen evenement verwijderen

Evenemenuitzonderingen

Basispad: /content/eventExceptions

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTHaal evenementuitzondering op ID
POST/JWTContent.EditEvenementuitzonderingen maken of bijwerken (batch)
DELETE/:idJWTContent.EditEen evenementuitzondering verwijderen

Samengestelde kalenders

Basispad: /content/curatedCalendars

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTHaal samengestelde kalender op ID
GET/JWTLijst alle samengestelde kalenders
POST/JWTContent.EditSamengestelde kalenders maken of bijwerken (batch)
DELETE/:idJWTContent.EditEen samengestelde kalender verwijderen

Samengestelde evenementen

Basispad: /content/curatedEvents

MethodePadVerwijzingToestemmingBeschrijving
GET/calendar/:curatedCalendarId?withoutEventsJWTHaal samengestelde evenementen voor kalender (inclusief evenementdetails en uitzonderingsdata, tenzij ?withoutEvents is ingesteld)
GET/public/calendar/:churchId/:curatedCalendarIdOpenbaarHaal openbare samengestelde evenementen voor kalender
GET/:idJWTHaal samengesteld evenement op ID
GET/JWTLijst alle samengestelde evenementen
POST/JWTContent.EditSamengestelde evenementen maken of bijwerken. Ondersteunt eventIds array om specifieke groepsfeiten toe te voegen
DELETE/:idJWTContent.EditEen samengesteld evenement verwijderen
DELETE/calendar/:curatedCalendarId/event/:eventIdJWTContent.EditVerwijder een specifiek evenement uit samengestelde kalender
DELETE/calendar/:curatedCalendarId/group/:groupIdJWTContent.EditVerwijder alle evenementen voor groep uit samengestelde kalender

Bestanden

Basispad: /content/files

MethodePadVerwijzingToestemmingBeschrijving
GET/:contentType/:contentIdJWTHaal bestanden per inhoudstype en inhouds-ID
GET/JWTLijst alle bestanden voor de kerkwebsite
GET/:idJWTHaal bestand op ID
POST/JWTContent.Edit*Upload bestanden (base64). *Ook toegestaan als gebruiker lid is van groep matching contentId
POST/postUrlJWTContent.Edit*Haal vooraf ondertekende S3 upload URL. *Ook toegestaan voor groepsleden. Max 100MB per inhoudsitem
DELETE/:idJWTContent.Edit*Verwijder bestand en verwijder uit opslag. *Ook toegestaan voor groepsleden

Galerij

Basispad: /content/gallery

MethodePadVerwijzingToestemmingBeschrijving
GET/stock/:folderOpenbaarLijst stockfoto's in folder
GET/:folderJWTContent.EditLijst galerijafbeeldingen in folder
POST/requestUploadJWTContent.EditHaal vooraf ondertekende S3 upload URL voor galerijafbeelding
DELETE/:folder/:imageJWTContent.EditVerwijder galerijafbeelding

Bijbels

Basispad: /content/bibles

Alle Bijbeleindpunten zijn openbaar (geen verificatie vereist). Gegevens worden opgehaald uit externe bronnen en lokaal gecached.

MethodePadVerwijzingToestemmingBeschrijving
GET/OpenbaarLijst alle Bijbelvertalingen (haalt uit bron als cache leeg is)
GET/stats?startDate=&endDate=OpenbaarHaal statistieken voor Bijbelzoekopdracht voor datumbereik
GET/availableTranslations/:sourceOpenbaarLijst beschikbare vertalingen vanuit bron (bijv. api.bible)
GET/updateTranslationsOpenbaarSynchroniseer alle vertalingen vanuit alle bronnen
GET/updateTranslations/:sourceOpenbaarSynchroniseer vertalingen vanuit specifieke bron
GET/updateCopyrightsOpenbaarUpdate copyrightinfo voor vertalingen zonder
GET/:translationKey/updateCopyrightOpenbaarUpdate copyright voor specifieke vertaling
GET/:translationKey/search?query=&limit=OpenbaarZoek verzen in vertaling
GET/:translationKey/booksOpenbaarHaal boeken voor vertaling (lokaal gecached)
GET/:translationKey/:bookKey/chaptersOpenbaarHaal hoofdstukken voor boek (lokaal gecached)
GET/:translationKey/chapters/:chapterKey/versesOpenbaarHaal verzen voor hoofdstuk (lokaal gecached)
GET/:translationKey/verses/:startVerseKey-:endVerseKeyOpenbaarHaal verzentekst voor bereik. Log zoekopdrachten. Sommige vertalingen omzeilen caching voor licentering

Voorbeeld: Verzentekst opvragen

GET /content/bibles/de4e12af7f28f599-02/verses/GEN.1.1-GEN.1.3
[
{ "verseKey": "GEN.1.1", "content": "In the beginning God created the heavens and the earth.", "bookKey": "GEN", "chapterNumber": 1, "verseNumber": 1 },
{ "verseKey": "GEN.1.2", "content": "Now the earth was formless and empty...", "bookKey": "GEN", "chapterNumber": 1, "verseNumber": 2 },
{ "verseKey": "GEN.1.3", "content": "And God said, \"Let there be light,\" and there was light.", "bookKey": "GEN", "chapterNumber": 1, "verseNumber": 3 }
]

Nummers

Basispad: /content/songs

MethodePadVerwijzingToestemmingBeschrijving
GET/search?q=JWTZoek nummers per zoekopdracht
GET/:idJWTHaal nummer op ID
GET/JWTContent.EditLijst alle nummers
POST/JWTContent.EditNummers maken of bijwerken (batch)
POST/importJWTImporteer nummers vanuit FreeShow (batch)
DELETE/:idJWTContent.EditEen nummer verwijderen

Nummerdetails

Basispad: /content/songDetails

Nummerdetails zijn globaal (niet kerk-bereikt). Deze vertegenwoordigen canonieke nummermetagegevens gedeeld in kerken.

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTHaal nummerdetail op ID (globaal)
GET/JWTLijst nummerdetails voor kerk
POST/createJWTMaak nummerdetail vanuit PraiseCharts-ID (retourneert bestaande als al gemaakt). Haalt automatisch metagegevens vanuit PraiseCharts en MusicBrainz
POST/JWTNummerdetails maken of bijwerken (batch)

Nummerkoppelingen

Basispad: /content/songDetailLinks

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTHaal nummerdetailkoppeling op ID
GET/songDetail/:songDetailIdJWTHaal alle koppelingen voor nummerdetail
POST/JWTNummerkoppelingen maken of bijwerken (batch). Haalt automatisch MusicBrainz-gegevens op als gekoppeld
DELETE/:idJWTEen nummerkoppeling verwijderen

Arrangementen

Basispad: /content/arrangements

MethodePadVerwijzingToestemmingBeschrijving
GET/:idJWTHaal arrangement op ID
GET/song/:songIdJWTContent.EditHaal arrangementen voor nummer
GET/songDetail/:songDetailIdJWTContent.EditHaal arrangementen voor nummerdetail
GET/JWTContent.EditLijst alle arrangementen
POST/JWTContent.EditArrangementen maken of bijwerken (batch)
POST/freeShow/missingJWTZoek FreeShow-ID's die niet in kerk voorkomen. Body: { freeShowIds: string[] }
DELETE/:idJWTContent.EditVerwijder arrangement (verwijdert ook sleutels; verwijdert nummer als geen arrangementen overblijven)

Arrangementsleuten

Basispad: /content/arrangementKeys

MethodePadVerwijzingToestemmingBeschrijving
GET/presenter/:churchId/:idOpenbaarHaal arrangementsleute met volledige nummergegevens voor presentator-weergave
GET/:idJWTHaal arrangementsleute op ID
GET/arrangement/:arrangementIdJWTContent.EditHaal sleutels voor arrangement
GET/JWTContent.EditLijst alle arrangementsleuten
POST/JWTContent.EditArrangementsleuten maken of bijwerken (batch)
DELETE/:idJWTContent.EditEen arrangementsleute verwijderen

Instellingen

Basispad: /content/settings

MethodePadVerwijzingToestemmingBeschrijving
GET/myJWTHaal huidige gebruikersinstellingen
GET/JWTSettings.EditHaal alle instellingen voor kerk
GET/public/:churchIdOpenbaarHaal openbare instellingen voor kerk (geretourneerd als sleutelwaardeparen)
POST/myJWTSla gebruikersinstellingen op (ondersteunt base64 afbeeldingopload)
POST/JWTSettings.EditSla kerkinstellingen op (ondersteunt base64 afbeeldingopload)
DELETE/my/:idJWTVerwijder gebruikersinstelling

Voorbeeld

Basispad: /content/preview

MethodePadVerwijzingToestemmingBeschrijving
GET/data/:keyOpenbaarLaad streaming preview gegevens voor kerk per subdomain sleutel (tabbladen, koppelingen, services, preken)

Galerij (Stockfoto's)

Basispad: /content/stock

MethodePadVerwijzingToestemmingBeschrijving
POST/searchOpenbaarZoek Pexels-stockfoto's. Body: { term: "church" }

PraiseCharts

Basispad: /content/praiseCharts

Integratie met PraiseCharts voor aanbiddingsliedontwikkeling en bladmuziek-downloads.

MethodePadVerwijzingToestemmingBeschrijving
GET/raw/:idJWTHaal ruwe PraiseCharts-gegevens voor nummer
GET/hasAccountJWTControleer of gebruiker gekoppelde PraiseCharts-account heeft
GET/search?q=JWTZoek PraiseCharts-catalogus
GET/products/:id?keys=JWTHaal producten voor nummer (uit bibliotheek als geverifieerd, anders catalogus)
GET/arrangement/raw/:id?keys=JWTHaal ruwe arrangementsgegevens uit bibliotheek
GET/download?skus=&keys=&file_name=JWTDownload bestand vanuit PraiseCharts (PDF of ZIP). Retourneert { redirectUrl }
GET/authUrl?returnUrl=OpenbaarHaal OAuth autorisatie URL voor PraiseCharts
GET/access?verifier=&token=&secret=JWTWissel OAuth-verifier voor toegangstoken en sla op in gebruikersinstellingen
GET/libraryJWTBlader gebruiker PraiseCharts bibliotheek

Ondersteuning

Basispad: /content/support

MethodePadVerwijzingToestemmingBeschrijving
POST/createAudioOpenbaarConverteer SSML naar MP3 audio met AWS Polly. Body: { ssml: "<speak>...</speak>" }

Gerelateerde pagina's