Hopp til hovedinnhold

Content-endepunkter

Content-modulen administrerer nettsider, seksjoner, elementer, blokker, prekener, spillelister, strømmingstjenester, hendelser, kuraterte kalendere, filer, gallerier, bibeloversettelser og versoppslag, sanger, arrangementer, globale stiler, arkivbilder og innstillinger. Det er den største modulen i API-et og driver CMS-et, medie-/strømmingsfunksjoner, lovsangplanlegging og bibelfunksjoner på tvers av alle ChurchApps-applikasjoner.

Basissti: /content

Sider

Basissti: /content/pages

MethodPathAuthPermissionDescription
GET/:churchId/tree?url=&id=PublicLast fullstendig sidetre (seksjoner, elementer, blokker) etter URL eller ID. Fjerner interne ID-er ved henting via URL
GET/:idJWTHent en side etter ID
GET/JWTList 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/JWTContent.EditOpprett eller oppdater sider (batch)
DELETE/:idJWTContent.EditSlett en side

Eksempel: Last 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

MethodPathAuthPermissionDescription
GET/:idJWTHent 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

MethodPathAuthPermissionDescription
GET/:idJWTHent et element etter ID
POST/duplicate/:idJWTContent.EditDupliser et element med alle underordnede
POST/JWTContent.EditOpprett eller oppdater elementer (batch). Administrerer radkolonner og karusellbilder automatisk
DELETE/:idJWTContent.EditSlett et element

Blokker

Basissti: /content/blocks

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

MethodPathAuthPermissionDescription
GET/:idJWTHent en blokk etter ID
GET/JWTList alle blokker
GET/:churchId/tree/:idPublicLast fullstendig blokktre med seksjoner og elementer
GET/blockType/:blockTypeJWTLast blokker etter type (f.eks. footerBlock, elementBlock)
GET/public/footer/:churchIdPublicLast bunntekstblokktre 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 baseklassen med Content.Edit-tillatelse for skriving).

MethodPathAuthPermissionDescription
GET/:idJWTHent en lenke etter ID
GET/JWTList alle lenker. Valgfritt ?category=-filter. Sorteres automatisk etter lagring
GET/church/:churchId/filtered?category=JWTLast lenker filtrert etter synlighet (alle, besøkende, medlemmer, ansatte, grupper)
GET/church/:churchId?category=PublicLast lenker for en kirke etter kategori (offentlig)
POST/JWTContent.EditOpprett eller oppdater lenker (batch). Sorteres automatisk etter kategori
DELETE/:idJWTContent.EditSlett en lenke

Globale stiler

Basissti: /content/globalStyles

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

MethodPathAuthPermissionDescription
GET/church/:churchIdPublicLast globale stiler for en kirke (returnerer standardverdier hvis ingen er angitt)
GET/JWTLast globale stiler for den autentiserte kirken
POST/JWTContent.EditOpprett eller oppdater globale stiler
DELETE/:idJWTContent.EditSlett globale stiler

Sidehistorikk

Basissti: /content/pageHistory

MethodPathAuthPermissionDescription
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 side-/blokkøyeblikksbilde. Rydder periodisk opp oppføringer eldre enn 30 dager
POST/restore/:idJWTContent.EditGjenopprett en side/blokk fra et historikkøyeblikksbilde (sletter gjeldende innhold og gjenskaper fra øyeblikksbildet)
POST/restoreSnapshotJWTContent.EditGjenopprett fra et innebygd øyeblikksobjekt. Body: { pageId, blockId, snapshot }

Prekener

Basissti: /content/sermons

MethodPathAuthPermissionDescription
GET/public/freeshowSampleJWTHent en eksempel FreeShow-spillelistestruktur
GET/public/tvWrapper/:churchIdJWTHent TV-app-wrapper med preken-, leksjons- og FreeShow-kilder
GET/public/tvFeed/:churchId/:sermonIdPublicHent en enkelt preken som TV-feed-spilleliste
GET/public/tvFeed/:churchIdPublicHent alle offentlige spillelister/prekener som TV-feed
GET/public/:churchIdPublicList alle offentlige prekener for en kirke
GET/timeline?sermonIds=JWTLast tidslinjedata for prekener
GET/lookup?videoType=&videoData=PublicSlå opp prekenmetadata fra YouTube eller Vimeo
GET/socialSuggestions?youtubeVideoId=JWTGenerer AI-forslag til sosiale medier-innlegg fra prekenundertekster
GET/outline?url=&title=&author=JWTGenerer AI-leksjonsoversikt fra en URL
GET/youtubeImport/:channelIdJWTImporter videoer fra en YouTube-kanal
GET/vimeoImport/:channelIdJWTImporter videoer fra en Vimeo-kanal
GET/:idJWTHent en preken etter ID
GET/JWTList alle prekener
POST/JWTStreamingServices.EditOpprett eller oppdater prekener (batch, støtter base64-miniatyrbildeopplasting)
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 baseklassen med StreamingServices.Edit-tillatelse for skriving).

MethodPathAuthPermissionDescription
GET/:idJWTHent en spilleliste etter ID
GET/JWTList alle spillelister
GET/public/:churchIdPublicList alle offentlige spillelister for en kirke
POST/JWTStreamingServices.EditOpprett eller oppdater spillelister (batch, støtter base64-miniatyrbildeopplasting)
DELETE/:idJWTStreamingServices.EditSlett en spilleliste

Strømmingstjenester

Basissti: /content/streamingServices

MethodPathAuthPermissionDescription
GET/:id/hostChatJWTChat.HostHent kryptert verts-chatrom-ID for en tjeneste
GET/JWTList alle strømmingstjenester. Rydder automatisk opp utløpte ikke-gjentagende tjenester og fremskynder gjentagende
POST/JWTStreamingServices.EditOpprett eller oppdater strømmingstjenester (batch)
DELETE/:idJWTStreamingServices.EditSlett en strømmingstjeneste (fjerner også blokkerte IP-er)

Hendelser

Basissti: /content/events

MethodPathAuthPermissionDescription
GET/timeline/group/:groupId?eventIds=JWTLast tidslinjehendelser for en gruppe
GET/timeline?eventIds=JWTLast tidslinjehendelser for gjeldende brukers grupper
GET/subscribe?churchId=&groupId=&curatedCalendarId=PublicAbonner på hendelser som ICS-kalender-feed
GET/group/:groupIdJWTHent hendelser for en gruppe (inkluderer unntaksdatoer)
GET/public/group/:churchId/:groupIdPublicHent offentlige hendelser for en gruppe
GET/:idJWTHent en hendelse etter ID
POST/JWTOpprett eller oppdater hendelser (batch)
DELETE/:idJWTContent.EditSlett en hendelse

Hendelsesunntak

Basissti: /content/eventExceptions

MethodPathAuthPermissionDescription
GET/:idJWTHent et hendelsesunntak etter ID
POST/JWTContent.EditOpprett eller oppdater hendelsesunntak (batch)
DELETE/:idJWTContent.EditSlett et hendelsesunntak

Kuraterte kalendere

Basissti: /content/curatedCalendars

MethodPathAuthPermissionDescription
GET/:idJWTHent en kuratert kalender etter ID
GET/JWTList alle kuraterte kalendere
POST/JWTContent.EditOpprett eller oppdater kuraterte kalendere (batch)
DELETE/:idJWTContent.EditSlett en kuratert kalender

Kuraterte hendelser

Basissti: /content/curatedEvents

MethodPathAuthPermissionDescription
GET/calendar/:curatedCalendarId?withoutEventsJWTHent kuraterte hendelser for en kalender (inkluderer hendelsesdetaljer og unntaksdatoer med mindre ?withoutEvents er satt)
GET/public/calendar/:churchId/:curatedCalendarIdPublicHent offentlige kuraterte hendelser for en kalender
GET/:idJWTHent en kuratert hendelse etter ID
GET/JWTList alle kuraterte hendelser
POST/JWTContent.EditOpprett eller oppdater kuraterte hendelser. Støtter eventIds-liste for å legge til spesifikke gruppehendelser
DELETE/:idJWTContent.EditSlett en kuratert hendelse
DELETE/calendar/:curatedCalendarId/event/:eventIdJWTContent.EditFjern en spesifikk hendelse fra en kuratert kalender
DELETE/calendar/:curatedCalendarId/group/:groupIdJWTContent.EditFjern alle hendelser for en gruppe fra en kuratert kalender

Filer

Basissti: /content/files

MethodPathAuthPermissionDescription
GET/:contentType/:contentIdJWTHent filer etter innholdstype og innholds-ID
GET/JWTList alle filer for kirkenettstedet
GET/:idJWTHent 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 fra lagring. *Også tillatt for gruppemedlemmer

Galleri

Basissti: /content/gallery

MethodPathAuthPermissionDescription
GET/stock/:folderPublicList arkivbilder 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 bibelendepunkter er offentlige (ingen autentisering kreves). Data hentes fra eksterne kilder og bufres lokalt.

MethodPathAuthPermissionDescription
GET/PublicList alle bibeloversettelser (henter fra kilde hvis bufferen er tom)
GET/stats?startDate=&endDate=PublicHent statistikk for bibeloppslag for en datoperiode
GET/availableTranslations/:sourcePublicList tilgjengelige oversettelser fra en kilde (f.eks. api.bible)
GET/updateTranslationsPublicSynkroniser alle oversettelser fra alle kilder
GET/updateTranslations/:sourcePublicSynkroniser oversettelser fra en spesifikk kilde
GET/updateCopyrightsPublicOppdater opphavsrettsinformasjon for oversettelser som mangler det
GET/:translationKey/updateCopyrightPublicOppdater opphavsrett for en spesifikk oversettelse
GET/:translationKey/search?query=&limit=PublicSøk vers i en oversettelse
GET/:translationKey/booksPublicHent bøker for en oversettelse (bufres lokalt)
GET/:translationKey/:bookKey/chaptersPublicHent kapitler for en bok (bufres lokalt)
GET/:translationKey/chapters/:chapterKey/versesPublicHent vers for et kapittel (bufres lokalt)
GET/:translationKey/verses/:startVerseKey-:endVerseKeyPublicHent verstekst for et område. Logger oppslag. Noen oversettelser omgår bufring på grunn av lisensiering

Eksempel: Hent verstekst

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

MethodPathAuthPermissionDescription
GET/search?q=JWTSøk sanger etter spørring
GET/:idJWTHent en sang etter ID
GET/JWTContent.EditList alle sanger
POST/JWTContent.EditOpprett eller oppdater sanger (batch)
POST/importJWTImporter sanger fra FreeShow (batch)
DELETE/:idJWTContent.EditSlett en sang

Sangdetaljer

Basissti: /content/songDetails

Sangdetaljer er globale (ikke kirke-avgrenset). Disse representerer kanoniske sangmetadata som deles på tvers av kirker.

MethodPathAuthPermissionDescription
GET/:idJWTHent en sangdetalj etter ID (global)
GET/JWTList sangdetaljer for kirken
POST/createJWTOpprett en sangdetalj fra PraiseCharts-ID (returnerer eksisterende hvis allerede opprettet). Henter metadata automatisk fra PraiseCharts og MusicBrainz
POST/JWTOpprett eller oppdater sangdetaljer (batch)

Sangdetaljlenker

Basissti: /content/songDetailLinks

MethodPathAuthPermissionDescription
GET/:idJWTHent en sangdetaljlenke etter ID
GET/songDetail/:songDetailIdJWTHent alle lenker for en sangdetalj
POST/JWTOpprett eller oppdater sangdetaljlenker (batch). Henter MusicBrainz-data automatisk hvis lenket
DELETE/:idJWTSlett en sangdetaljlenke

Arrangementer

Basissti: /content/arrangements

MethodPathAuthPermissionDescription
GET/:idJWTHent 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/missingJWTFinn 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)

Arrangementstonearter

Basissti: /content/arrangementKeys

MethodPathAuthPermissionDescription
GET/presenter/:churchId/:idPublicHent arrangementtoneart med fullstendige sangdata for presentasjonsvisning
GET/:idJWTHent en arrangementtoneart etter ID
GET/arrangement/:arrangementIdJWTContent.EditHent tonearter for et arrangement
GET/JWTContent.EditList alle arrangementstonearter
POST/JWTContent.EditOpprett eller oppdater arrangementstonearter (batch)
DELETE/:idJWTContent.EditSlett en arrangementtoneart

Innstillinger

Basissti: /content/settings

MethodPathAuthPermissionDescription
GET/myJWTHent gjeldende brukers innstillinger
GET/JWTSettings.EditHent alle innstillinger for kirken
GET/public/:churchIdPublicHent offentlige innstillinger for en kirke (returneres som nøkkel-verdi-par)
GET/imports?playlistId=&channelId=&type=JWTSettings.EditHent automatiske importinnstillinger (YouTube-/Vimeo-kanal-ID-er)
POST/myJWTLagre innstillinger på brukernivå (støtter base64-bildeopplasting)
POST/JWTSettings.EditLagre innstillinger på kirkenivå (støtter base64-bildeopplasting)
DELETE/my/:idJWTSlett en brukerinnstilling

Forhåndsvisning

Basissti: /content/preview

MethodPathAuthPermissionDescription
GET/data/:keyPublicLast strømmingsforhåndsvisningsdata for en kirke etter underdomene-nøkkel (faner, lenker, tjenester, prekener)

Galleri (arkivbilder)

Basissti: /content/stock

MethodPathAuthPermissionDescription
POST/searchPublicSøk Pexels-arkivbilder. Body: { term: "church" }

PraiseCharts

Basissti: /content/praiseCharts

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

MethodPathAuthPermissionDescription
GET/raw/:idJWTHent rå PraiseCharts-data for en sang
GET/hasAccountJWTSjekk om brukeren har en tilknyttet PraiseCharts-konto
GET/search?q=JWTSøk i PraiseCharts-katalogen
GET/products/:id?keys=JWTHent produkter for en sang (fra bibliotek hvis autentisert, ellers katalog)
GET/arrangement/raw/:id?keys=JWTHent rå arrangementdata fra bibliotek
GET/download?skus=&keys=&file_name=JWTLast ned en fil fra PraiseCharts (PDF eller ZIP). Returnerer { redirectUrl }
GET/authUrl?returnUrl=PublicHent OAuth-autoriserings-URL for PraiseCharts
GET/access?verifier=&token=&secret=JWTBytt OAuth-verifikator mot tilgangstoken og lagre i brukerinnstillinger
GET/libraryJWTBla gjennom brukerens PraiseCharts-bibliotek

Støtte

Basissti: /content/support

MethodPathAuthPermissionDescription
POST/createAudioPublicKonverter SSML til MP3-lyd ved hjelp av AWS Polly. Body: { ssml: "<speak>...</speak>" }

Relaterte sider