Hopp til hovedinnhold

Innhold-endepunkter

Innhold-modulen administrerer nettsider, seksjoner, elementer, blokker, blogginnlegg, omdirigeringer, prekener, spillelister, strømmetjenester, hendelser, kuraterte kalendere, filer, gallerier, bibeloversettelser og versoppslag, sanger, låtarrangementer, globale stiler, stockfoto og innstillinger. Den er den største modulen i API-et og driver CMS, medie/strømming, gudstjenesteplanlegging og bibelfunksjoner på tvers av alle ChurchApps-applikasjoner.

Basissti: /content

Sider​

Basissti: /content/pages

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:churchId/tree?url=&id=Offentlig—Last inn hele sidetreet (seksjoner, elementer, blokker) etter URL eller ID. Fjerner interne ID-er når det hentes etter URL. URL-baserte henting håndhever pages.visibility — en låst side returnerer { restricted: true, visibility } med mindre den (valgfrie) JWT-en oppfyller kravet
GET/public/:churchIdOffentlig—List offentlige sider (url, title, metaDescription); bare visibility = everyone
GET/:idJWT—Hent en side etter ID
GET/JWT—List alle sider for kirken
POST/duplicate/:idJWTContent.EditDupliser en side med alle seksjoner og elementer
POST/temp/aiJWTContent.EditLagre en AI-generert side (side, seksjoner og elementer i ett kall)
POST/importTreeJWTContent.EditOpprett en side fra et nestet tre (title, url, sections[].elements[]…). Settes alltid inn under innringerens kirke; ID-er i body-en ignoreres. Rader må inkludere sine column-barn. Maks 30 seksjoner / 500 elementer
POST/JWTContent.EditOpprett eller oppdater sider (batch)
DELETE/:idJWTContent.EditSlett en side

Eksempel: Last inn sidetre​

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

Seksjoner​

Basissti: /content/sections

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent en seksjon etter ID
POST/duplicate/:id?convertToBlock=JWTContent.EditDupliser en seksjon eller konverter den til en gjenbrukbar blokk
POST/JWTContent.EditOpprett eller oppdater seksjoner (batch). Oppdaterer sorteringsrekkefølge automatisk
DELETE/:idJWTContent.EditSlett en seksjon (oppdaterer sorteringsrekkefølge automatisk)

Elementer​

Basissti: /content/elements

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent et element etter ID
POST/duplicate/:idJWTContent.EditDupliser et element med alle underordnede elementer
POST/JWTContent.EditOpprett eller oppdater elementer (batch). Administrerer radkolonner og karusellysbilder automatisk
DELETE/:idJWTContent.EditSlett et element

Blokker​

Basissti: /content/blocks

Utvider standard CRUD (GET /:id, GET /, POST /, DELETE /:id fra basisklassen med Content.Edit-tillatelse for skriveoperasjoner).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent en blokk etter ID
GET/JWT—List alle blokker
GET/:churchId/tree/:idOffentlig—Last inn hele bloktreet med seksjoner og elementer
GET/blockType/:blockTypeJWT—Last inn blokker etter type (f.eks. footerBlock, elementBlock)
GET/public/footer/:churchIdOffentlig—Last inn bunntekst-bloktreet for en kirke
POST/JWTContent.EditOpprett eller oppdater blokker
DELETE/:idJWTContent.EditSlett en blokk

Lenker​

Basissti: /content/links

Utvider standard CRUD (GET /:id, GET /, POST /, DELETE /:id fra basisklassen med Content.Edit-tillatelse for skriveoperasjoner).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent en lenke etter ID
GET/JWT—List alle lenker. Valgfritt filter ?category=. Sorterer automatisk etter lagring
GET/church/:churchId/filtered?category=JWT—Last inn lenker filtrert etter synlighet (everyone, visitors, members, staff, groups)
GET/church/:churchId?category=Offentlig—Last inn lenker for en kirke etter kategori (offentlig)
POST/JWTContent.EditOpprett eller oppdater lenker (batch). Sorterer automatisk etter kategori
DELETE/:idJWTContent.EditSlett en lenke

Globale stiler​

Basissti: /content/globalStyles

Utvider standard CRUD (POST /, DELETE /:id fra basisklassen med Content.Edit-tillatelse for skriveoperasjoner).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/church/:churchIdOffentlig—Last inn globale stiler for en kirke (returnerer standardverdier hvis ingen er satt)
GET/JWT—Last inn globale stiler for den autentiserte kirken
POST/JWTContent.EditOpprett eller oppdater globale stiler
DELETE/:idJWTContent.EditSlett globale stiler

Sidehistorikk​

Basissti: /content/pageHistory

MetodeStiAutentiseringTillatelseBeskrivelse
GET/page/:pageIdJWTContent.EditList historikkoppføringer for en side
GET/block/:blockIdJWTContent.EditList historikkoppføringer for en blokk
GET/:idJWTContent.EditHent en historikkoppføring etter ID
POST/JWTContent.EditLagre et øyeblikksbilde av en side/blokk. Rydder periodisk opp i oppføringer eldre enn 30 dager
POST/restore/:idJWTContent.EditGjenopprett en side/blokk fra et historikkøyeblikksbilde (sletter gjeldende innhold og oppretter det på nytt fra øyeblikksbildet)
POST/restoreSnapshotJWTContent.EditGjenopprett fra et innebygd øyeblikksbildeobjekt. Body: { pageId, blockId, snapshot }

Innlegg (blogg)​

Basissti: /content/posts

Blogginnlegg er frittstående rader: title, slug (unik per kirke), excerpt, content (markdown-innhold), authorId, photoUrl, publishDate, category og tags. Et innlegg publiseres når publishDate er satt og ligger i fortiden. Leseendepunkter beriker hvert innlegg med authorName hentet fra authorId. Se Arkitektur for nettsidebyggeren.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/public/:churchId?category=&tag=&page=&pageSize=Offentlig—List publiserte innlegg, paginert (maks 50 per side)
GET/public/:churchId/categoriesOffentlig—Distinkte kategorier på tvers av publiserte innlegg
GET/public/:churchId/slug/:slugOffentlig—Hent et publisert innlegg etter slug
GET/rss/:churchId?siteUrl=Offentlig—RSS 2.0-feed av publiserte innlegg (lenker bygges som {siteUrl}/blog/{slug})
GET/:idJWT—Hent et innlegg etter ID
GET/JWT—List alle innlegg for kirken
POST/JWTContent.EditOpprett eller oppdater innlegg (batch)
DELETE/:idJWTContent.EditSlett et innlegg

Omdirigeringer​

Basissti: /content/redirects

URL-omdirigeringer per kirke (fromPath → toPath), begrenset til 200 per kirke. Stier normaliseres (små bokstaver, innledende skråstrek, ingen avsluttende skråstrek), og fromPath er unik per kirke. B1App løser disse ved mulige 404-feil og utsteder en HTTP 308.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/public/:churchId?path=Offentlig—Løs opp en sti (eller list alle omdirigeringer når path utelates)
GET/:idJWT—Hent en omdirigering etter ID
GET/JWT—List alle omdirigeringer for kirken
POST/JWTContent.EditOpprett eller oppdater omdirigeringer. Avviser fromPath = toPath og håndhever grensen på 200 rader
DELETE/:idJWTContent.EditSlett en omdirigering

Prekener​

Basissti: /content/sermons

MetodeStiAutentiseringTillatelseBeskrivelse
GET/public/freeshowSampleJWT—Hent en eksempelstruktur for FreeShow-spilleliste
GET/public/tvWrapper/:churchIdJWT—Hent TV-app-wrapper med preken-, leksjons- og FreeShow-kilder
GET/public/tvFeed/:churchId/:sermonIdOffentlig—Hent en enkelt preken som en TV-feed-spilleliste
GET/public/tvFeed/:churchIdOffentlig—Hent alle offentlige spillelister/prekener som en TV-feed
GET/public/:churchIdOffentlig—List alle offentlige prekener for en kirke
GET/timeline?sermonIds=JWT—Last inn tidslinjedata for prekener
GET/lookup?videoType=&videoData=Offentlig—Slå opp prekenmetadata fra YouTube eller Vimeo
GET/socialSuggestions?youtubeVideoId=JWT—Generer AI-forslag til innlegg i sosiale medier basert på undertekster fra preken
GET/outline?url=&title=&author=JWT—Generer AI-leksjonsdisposisjon fra en URL
GET/youtubeImport/:channelIdJWT—Importer videoer fra en YouTube-kanal. HTML-entiteter som YouTubes søke-API legger i titler og beskrivelser (f.eks. & og ') dekodes
GET/vimeoImport/:channelIdJWT—Importer videoer fra en Vimeo-kanal
GET/:idJWT—Hent en preken etter ID
GET/JWT—List alle prekener
POST/JWTStreamingServices.EditOpprett eller oppdater prekener. Godtar en array eller et enkelt prekenobjekt (returnerer alltid en array); en tom body returnerer 400. Støtter opplasting av miniatyrbilde i base64
DELETE/:idJWTStreamingServices.EditSlett en preken

Eksempel: Slå opp en YouTube-preken​

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

Spillelister​

Basissti: /content/playlists

Utvider standard CRUD (GET /:id, GET /, DELETE /:id fra basisklassen med StreamingServices.Edit-tillatelse for skriveoperasjoner).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent en spilleliste etter ID
GET/JWT—List alle spillelister
GET/public/:churchIdOffentlig—List alle offentlige spillelister for en kirke
POST/JWTStreamingServices.EditOpprett eller oppdater spillelister (batch, støtter opplasting av miniatyrbilde i base64)
DELETE/:idJWTStreamingServices.EditSlett en spilleliste

Strømmetjenester​

Basissti: /content/streamingServices

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:id/hostChatJWTChat.HostHent kryptert vertschat-rom-ID for en tjeneste
GET/JWT—List alle strømmetjenester. Rydder automatisk opp i utløpte ikke-gjentakende tjenester og flytter gjentakende tjenester videre
POST/JWTStreamingServices.EditOpprett eller oppdater strømmetjenester (batch)
DELETE/:idJWTStreamingServices.EditSlett en strømmetjeneste (fjerner også blokkerte IP-er)

Hendelser​

Basissti: /content/events

MetodeStiAutentiseringTillatelseBeskrivelse
GET/timeline/group/:groupId?eventIds=JWT—Last inn tidslinjehendelser for en gruppe (inkluderer unntaksdatoer, slik at slettede forekomster kan hoppes over)
GET/timeline?eventIds=JWT—Last inn tidslinjehendelser for den innloggede brukerens grupper (inkluderer unntaksdatoer)
GET/subscribe?churchId=&groupId=&curatedCalendarId=Offentlig—Abonner på hendelser som ICS-kalenderfeed
GET/group/:groupIdJWT—Hent hendelser for en gruppe (inkluderer unntaksdatoer)
GET/public/group/:churchId/:groupIdOffentlig—Hent offentlige hendelser for en gruppe
GET/public/:churchId/:idOffentlig—Hent én hendelse for dens offentlige side, med roomNames (rom fra bookinger som ikke er avvist). Returnerer null for ventende eller avviste hendelser, og for private hendelser som ikke tar imot påmeldinger
GET/public/:churchId/:id/icalOffentlig—Last ned den enkelte hendelsen som en .ics-fil (text/calendar, med unntaksdatoer brukt). 404 når hendelsen er skjult etter de samme reglene
GET/:idJWT—Hent en hendelse etter ID
POST/JWT—Opprett eller oppdater hendelser (batch)
DELETE/:idJWTContent.Edit, Calendars.Admin eller gruppelederSlett en hendelse og dens bookinger. Ledere av hendelsens gruppe kan slette den, og avsenderen av forespørselen kan trekke tilbake sin egen ventende forespørsel

Hendelsesposter inkluderer photoUrl (hendelsesbildet i 16:9 som vises på den offentlige hendelsessiden og i kommende hendelsesfliser), tags (kommaseparert, brukt av kalenderelementet på nettsiden til tagfiltrering), og notesViewRole / notesPostRole (staff når null, leaders eller members), som styrer hendelsens eventNote-samtale — se Tilgangskontroll for gruppe- og hendelsesnotater. Svar for offentlige kuraterte hendelser inneholder også hver hendelses photoUrl og tags.

Unntak for hendelser​

Basissti: /content/eventExceptions

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent et hendelsesunntak etter ID
POST/JWTContent.Edit, Calendars.Admin eller gruppelederOpprett eller oppdater hendelsesunntak (batch). Ledere kan bare legge til unntak for hendelser i grupper de leder
DELETE/:idJWTContent.Edit, Calendars.Admin eller gruppelederSlett et hendelsesunntak

Kuraterte kalendere​

Basissti: /content/curatedCalendars

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent en kuratert kalender etter ID
GET/JWT—List alle kuraterte kalendere
POST/JWTContent.EditOpprett eller oppdater kuraterte kalendere (batch)
DELETE/:idJWTContent.EditSlett en kuratert kalender

Kuraterte hendelser​

Basissti: /content/curatedEvents

MetodeStiAutentiseringTillatelseBeskrivelse
GET/calendar/:curatedCalendarId?withoutEventsJWT—Hent kuraterte hendelser for en kalender (inkluderer hendelsesdetaljer og unntaksdatoer med mindre ?withoutEvents er satt)
GET/public/calendar/:churchId/:curatedCalendarIdOffentlig—Hent offentlige kuraterte hendelser for en kalender
GET/:idJWT—Hent en kuratert hendelse etter ID
GET/JWT—List alle kuraterte hendelser
POST/JWTContent.EditOpprett eller oppdater kuraterte hendelser. Støtter eventIds-array for å legge til bestemte gruppehendelser
DELETE/:idJWTContent.EditSlett en kuratert hendelse
DELETE/calendar/:curatedCalendarId/event/:eventIdJWTContent.EditFjern en bestemt hendelse fra en kuratert kalender
DELETE/calendar/:curatedCalendarId/group/:groupIdJWTContent.EditFjern alle hendelser for en gruppe fra en kuratert kalender

Filer​

Basissti: /content/files

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:contentType/:contentIdJWT—Hent filer etter innholdstype og innholds-ID
GET/JWT—List alle filer for kirkens nettside
GET/:idJWT—Hent en fil etter ID
POST/JWTContent.Edit*Last opp filer (base64). *Også tillatt hvis brukeren er medlem av gruppen som samsvarer med contentId
POST/postUrlJWTContent.Edit*Hent en forhåndssignert S3-opplastings-URL. *Også tillatt for gruppemedlemmer. Maks 100 MB per innholdselement
DELETE/:idJWTContent.Edit*Slett en fil og fjern den fra lagringen. *Også tillatt for gruppemedlemmer

Galleri​

Basissti: /content/gallery

MetodeStiAutentiseringTillatelseBeskrivelse
GET/stock/:folderOffentlig—List stockfoto i en mappe
GET/:folderJWTContent.EditList galleribilder i en mappe
POST/requestUploadJWTContent.EditHent en forhåndssignert S3-opplastings-URL for et galleribilde
DELETE/:folder/:imageJWTContent.EditSlett et galleribilde

Bibler​

Basissti: /content/bibles

Alle bibel-endepunkter er offentlige (ingen autentisering kreves). Data hentes fra eksterne kilder og caches lokalt. Forespørsler til api.bible tidsavbrytes etter 15 sekunder; en tidsavbrytelse returnerer 504.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/Offentlig—List alle bibeloversettelser (henter fra kilden hvis cachen er tom)
GET/stats?startDate=&endDate=Offentlig—Hent statistikk over bibeloppslag for et datoområde
GET/availableTranslations/:sourceOffentlig—List tilgjengelige oversettelser fra en kilde (f.eks. api.bible)
GET/updateTranslationsOffentlig—Synkroniser alle oversettelser fra alle kilder
GET/updateTranslations/:sourceOffentlig—Synkroniser oversettelser fra en bestemt kilde
GET/updateCopyrightsOffentlig—Oppdater opphavsrettsinformasjon for oversettelser som mangler den
GET/:translationKey/updateCopyrightOffentlig—Oppdater opphavsrett for en bestemt oversettelse
GET/:translationKey/search?query=&limit=Offentlig—Søk etter vers i en oversettelse
GET/:translationKey/booksOffentlig—Hent bøker for en oversettelse (cacher lokalt)
GET/:translationKey/:bookKey/chaptersOffentlig—Hent kapitler for en bok (cacher lokalt)
GET/:translationKey/chapters/:chapterKey/versesOffentlig—Hent vers for et kapittel (cacher lokalt)
GET/:translationKey/verses/:startVerseKey-:endVerseKeyOffentlig—Hent versetekst for et område. Logger oppslag. Noen oversettelser omgår caching av lisenshensyn

Eksempel: Hent versetekst​

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

Sanger​

Basissti: /content/songs

MetodeStiAutentiseringTillatelseBeskrivelse
GET/search?q=JWT—Søk etter sanger med en søkestreng
GET/:idJWT—Hent en sang etter ID
GET/JWTContent.EditList alle sanger
POST/JWTContent.EditOpprett eller oppdater sanger (batch)
POST/importJWT—Importer sanger fra FreeShow (batch)
DELETE/:idJWTContent.EditSlett en sang

Sangdetaljer​

Basissti: /content/songDetails

Sangdetaljer er globale (ikke knyttet til kirke). De representerer kanoniske sangmetadata som deles mellom kirker.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent en sangdetalj etter ID (global)
GET/JWT—List sangdetaljer for kirken
POST/createJWT—Opprett en sangdetalj fra en PraiseCharts-ID (returnerer eksisterende hvis den allerede er opprettet). Henter metadata automatisk fra PraiseCharts og MusicBrainz
POST/JWT—Opprett eller oppdater sangdetaljer (batch)

Sangdetaljlenker​

Basissti: /content/songDetailLinks

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent en sangdetaljlenke etter ID
GET/songDetail/:songDetailIdJWT—Hent alle lenker for en sangdetalj
POST/JWT—Opprett eller oppdater sangdetaljlenker (batch). Henter MusicBrainz-data automatisk hvis koblet
DELETE/:idJWT—Slett en sangdetaljlenke

Arrangementer​

Basissti: /content/arrangements

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:idJWT—Hent et arrangement etter ID
GET/song/:songIdJWTContent.EditHent arrangementer for en sang
GET/songDetail/:songDetailIdJWTContent.EditHent arrangementer for en sangdetalj
GET/JWTContent.EditList alle arrangementer
POST/JWTContent.EditOpprett eller oppdater arrangementer (batch)
POST/freeShow/missingJWT—Finn FreeShow-ID-er som ikke finnes i kirken. Body: { freeShowIds: string[] }
DELETE/:idJWTContent.EditSlett et arrangement (sletter også tonearter; sletter sangen hvis ingen arrangementer gjenstår)

Arrangementtonearter​

Basissti: /content/arrangementKeys

MetodeStiAutentiseringTillatelseBeskrivelse
GET/presenter/:churchId/:idOffentlig—Hent arrangementtonart med fullstendige sangdata for presentasjonsvisningen
GET/:idJWT—Hent en arrangementtonart etter ID
GET/arrangement/:arrangementIdJWTContent.EditHent tonearter for et arrangement
GET/JWTContent.EditList alle arrangementtonearter
POST/JWTContent.EditOpprett eller oppdater arrangementtonearter (batch)
DELETE/:idJWTContent.EditSlett en arrangementtonart

Innstillinger​

Basissti: /content/settings

MetodeStiAutentiseringTillatelseBeskrivelse
GET/myJWT—Hent gjeldende brukers innstillinger
GET/JWTSettings.EditHent alle innstillinger for kirken
GET/public/:churchIdOffentlig—Hent offentlige innstillinger for en kirke (returneres som nøkkel-verdi-par)
POST/myJWT—Lagre brukernivåinnstillinger (støtter opplasting av bilde i base64)
POST/JWTSettings.EditLagre kirkeinnstillinger (støtter opplasting av bilde i base64)
DELETE/my/:idJWT—Slett en brukerinnstilling

Forhåndsvisning​

Basissti: /content/preview

MetodeStiAutentiseringTillatelseBeskrivelse
GET/data/:keyOffentlig—Last inn forhåndsvisningsdata for strømming for en kirke etter subdomene-nøkkel (faner, lenker, tjenester, prekener)

Galleri (stockfoto)​

Basissti: /content/stock

MetodeStiAutentiseringTillatelseBeskrivelse
POST/searchOffentlig—Søk etter stockfoto på Pexels. Body: { term: "church" }

PraiseCharts​

Basissti: /content/praiseCharts

Integrasjon med PraiseCharts for oppdagelse av lovsanger og nedlasting av noter.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/raw/:idJWT—Hent rådata fra PraiseCharts for en sang
GET/hasAccountJWT—Sjekk om brukeren har en koblet PraiseCharts-konto
GET/search?q=JWT—Søk i PraiseCharts-katalogen
GET/products/:id?keys=JWT—Hent produkter for en sang (fra biblioteket hvis autentisert, ellers fra katalogen)
GET/arrangement/raw/:id?keys=JWT—Hent rå arrangementdata fra biblioteket
GET/download?skus=&keys=&file_name=JWT—Last ned en fil fra PraiseCharts (PDF eller ZIP). Returnerer { redirectUrl }
GET/authUrl?returnUrl=Offentlig—Hent OAuth-autoriseringslenke for PraiseCharts
GET/access?verifier=&token=&secret=JWT—Veksle OAuth-verifikator mot tilgangstoken og lagre i brukerinnstillinger
GET/libraryJWT—Bla i brukerens PraiseCharts-bibliotek

Støtte​

Basissti: /content/support

MetodeStiAutentiseringTillatelseBeskrivelse
POST/createAudioOffentlig—Konverter SSML til MP3-lyd med AWS Polly. Body: { ssml: "<speak>...</speak>" }

Relaterte sider​