Lumipat sa pangunahing nilalaman

Mga Endpoint ng Content

Pinapamahalaan ng Content module ang mga pahina ng website, seksyon, elemento, block, sermon, playlist, streaming service, event, curated calendar, file, gallery, mga salin ng Bibliya at paghahanap ng talata, kanta, arrangement, global style, stock photo, at setting. Ito ang pinakamalaking module sa API at nagpapaandar ng CMS, media/streaming, pagpaplano ng pagsamba, at mga tampok ng Bibliya sa lahat ng ChurchApps na aplikasyon.

Base path: /content

Mga Pahina

Base path: /content/pages

MethodPathAuthPermissionPaglalarawan
GET/:churchId/tree?url=&id=PampublikoI-load ang buong puno ng pahina (mga seksyon, elemento, block) ayon sa URL o ID. Tinatanggal ang mga internal ID kapag kinuha ayon sa URL
GET/:idJWTKunin ang isang pahina ayon sa ID
GET/JWTIlista ang lahat ng pahina para sa simbahan
POST/duplicate/:idJWTContent.EditDuplicate ang isang pahina kasama ang lahat ng seksyon at elemento
POST/temp/aiJWTContent.EditI-save ang isang pahinang ginawa ng AI (pahina, seksyon, at elemento sa isang tawag)
POST/JWTContent.EditLumikha o mag-update ng mga pahina (batch)
DELETE/:idJWTContent.EditBurahin ang isang pahina

Halimbawa: I-load ang Puno ng Pahina

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

Mga Seksyon

Base path: /content/sections

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang seksyon ayon sa ID
POST/duplicate/:id?convertToBlock=JWTContent.EditI-duplicate ang isang seksyon o i-convert ito sa reusable na block
POST/JWTContent.EditLumikha o mag-update ng mga seksyon (batch). Awtomatikong ina-update ang sort order
DELETE/:idJWTContent.EditBurahin ang isang seksyon (awtomatikong ina-update ang sort order)

Mga Elemento

Base path: /content/elements

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang elemento ayon sa ID
POST/duplicate/:idJWTContent.EditI-duplicate ang isang elemento kasama ang lahat ng mga anak
POST/JWTContent.EditLumikha o mag-update ng mga elemento (batch). Awtomatikong pinapamahalaan ang mga kolum ng hilera at slide ng carousel
DELETE/:idJWTContent.EditBurahin ang isang elemento

Mga Block

Base path: /content/blocks

Nag-eextend ng karaniwang CRUD (GET /:id, GET /, POST /, DELETE /:id mula sa base class na may pahintulot na Content.Edit para sa mga pagsusulat).

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang block ayon sa ID
GET/JWTIlista ang lahat ng block
GET/:churchId/tree/:idPampublikoI-load ang buong puno ng block kasama ang mga seksyon at elemento
GET/blockType/:blockTypeJWTI-load ang mga block ayon sa uri (hal. footerBlock, elementBlock)
GET/public/footer/:churchIdPampublikoI-load ang puno ng footer block para sa isang simbahan
POST/JWTContent.EditLumikha o mag-update ng mga block
DELETE/:idJWTContent.EditBurahin ang isang block

Base path: /content/links

Nag-eextend ng karaniwang CRUD (GET /:id, GET /, POST /, DELETE /:id mula sa base class na may pahintulot na Content.Edit para sa mga pagsusulat).

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang link ayon sa ID
GET/JWTIlista ang lahat ng link. Opsyonal na filter ayon sa ?category=. Awtomatikong isinasaayos pagkatapos mag-save
GET/church/:churchId/filtered?category=JWTI-load ang mga link na na-filter ayon sa visibility (lahat, bisita, miyembro, kawani, grupo)
GET/church/:churchId?category=PampublikoI-load ang mga link para sa isang simbahan ayon sa kategorya (pampubliko)
POST/JWTContent.EditLumikha o mag-update ng mga link (batch). Awtomatikong isinasaayos ayon sa kategorya
DELETE/:idJWTContent.EditBurahin ang isang link

Mga Global Style

Base path: /content/globalStyles

Nag-eextend ng karaniwang CRUD (POST /, DELETE /:id mula sa base class na may pahintulot na Content.Edit para sa mga pagsusulat).

MethodPathAuthPermissionPaglalarawan
GET/church/:churchIdPampublikoI-load ang mga global style para sa isang simbahan (nagbabalik ng mga default kung wala pang naitakda)
GET/JWTI-load ang mga global style para sa naka-authenticate na simbahan
POST/JWTContent.EditLumikha o mag-update ng mga global style
DELETE/:idJWTContent.EditBurahin ang mga global style

Kasaysayan ng Pahina

Base path: /content/pageHistory

MethodPathAuthPermissionPaglalarawan
GET/page/:pageIdJWTContent.EditIlista ang mga entry ng kasaysayan para sa isang pahina
GET/block/:blockIdJWTContent.EditIlista ang mga entry ng kasaysayan para sa isang block
GET/:idJWTContent.EditKunin ang isang entry ng kasaysayan ayon sa ID
POST/JWTContent.EditI-save ang isang snapshot ng pahina/block. Pana-panahong nililinis ang mga entry na mas matanda sa 30 araw
POST/restore/:idJWTContent.EditI-restore ang isang pahina/block mula sa isang snapshot ng kasaysayan (binubura ang kasalukuyang nilalaman at nililikha muli mula sa snapshot)
POST/restoreSnapshotJWTContent.EditI-restore mula sa isang inline na snapshot object. Body: { pageId, blockId, snapshot }

Mga Sermon

Base path: /content/sermons

MethodPathAuthPermissionPaglalarawan
GET/public/freeshowSampleJWTKumuha ng halimbawang istraktura ng FreeShow playlist
GET/public/tvWrapper/:churchIdJWTKumuha ng TV app wrapper na may mga pinagmulan ng sermon, aralin, at FreeShow
GET/public/tvFeed/:churchId/:sermonIdPampublikoKumuha ng isang sermon bilang TV feed playlist
GET/public/tvFeed/:churchIdPampublikoKumuha ng lahat ng pampublikong playlist/sermon bilang TV feed
GET/public/:churchIdPampublikoIlista ang lahat ng pampublikong sermon para sa isang simbahan
GET/timeline?sermonIds=JWTI-load ang data ng timeline para sa mga sermon
GET/lookup?videoType=&videoData=PampublikoMaghanap ng metadata ng sermon mula sa YouTube o Vimeo
GET/socialSuggestions?youtubeVideoId=JWTBumuo ng mga mungkahi ng AI social media post mula sa mga subtitle ng sermon
GET/outline?url=&title=&author=JWTBumuo ng AI lesson outline mula sa isang URL
GET/youtubeImport/:channelIdJWTMag-import ng mga video mula sa isang YouTube channel
GET/vimeoImport/:channelIdJWTMag-import ng mga video mula sa isang Vimeo channel
GET/:idJWTKunin ang isang sermon ayon sa ID
GET/JWTIlista ang lahat ng sermon
POST/JWTStreamingServices.EditLumikha o mag-update ng mga sermon (batch, sinusuportahan ang base64 na pag-upload ng thumbnail)
DELETE/:idJWTStreamingServices.EditBurahin ang isang sermon

Halimbawa: Maghanap ng YouTube Sermon

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

Mga Playlist

Base path: /content/playlists

Nag-eextend ng karaniwang CRUD (GET /:id, GET /, DELETE /:id mula sa base class na may pahintulot na StreamingServices.Edit para sa mga pagsusulat).

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang playlist ayon sa ID
GET/JWTIlista ang lahat ng playlist
GET/public/:churchIdPampublikoIlista ang lahat ng pampublikong playlist para sa isang simbahan
POST/JWTStreamingServices.EditLumikha o mag-update ng mga playlist (batch, sinusuportahan ang base64 na pag-upload ng thumbnail)
DELETE/:idJWTStreamingServices.EditBurahin ang isang playlist

Mga Streaming Service

Base path: /content/streamingServices

MethodPathAuthPermissionPaglalarawan
GET/:id/hostChatJWTChat.HostKunin ang naka-encrypt na host chat room ID para sa isang serbisyo
GET/JWTIlista ang lahat ng streaming service. Awtomatikong nililinis ang mga expired na hindi umuulit na serbisyo at iniaabante ang mga umuulit
POST/JWTStreamingServices.EditLumikha o mag-update ng mga streaming service (batch)
DELETE/:idJWTStreamingServices.EditBurahin ang isang streaming service (binubura din ang mga naka-block na IP)

Mga Event

Base path: /content/events

MethodPathAuthPermissionPaglalarawan
GET/timeline/group/:groupId?eventIds=JWTI-load ang mga timeline event para sa isang grupo
GET/timeline?eventIds=JWTI-load ang mga timeline event para sa mga grupo ng kasalukuyang gumagamit
GET/subscribe?churchId=&groupId=&curatedCalendarId=PampublikoMag-subscribe sa mga event bilang ICS calendar feed
GET/group/:groupIdJWTKunin ang mga event para sa isang grupo (kasama ang mga exception date)
GET/public/group/:churchId/:groupIdPampublikoKunin ang mga pampublikong event para sa isang grupo
GET/:idJWTKunin ang isang event ayon sa ID
POST/JWTLumikha o mag-update ng mga event (batch)
DELETE/:idJWTContent.EditBurahin ang isang event

Mga Event Exception

Base path: /content/eventExceptions

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang event exception ayon sa ID
POST/JWTContent.EditLumikha o mag-update ng mga event exception (batch)
DELETE/:idJWTContent.EditBurahin ang isang event exception

Mga Curated Calendar

Base path: /content/curatedCalendars

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang curated calendar ayon sa ID
GET/JWTIlista ang lahat ng curated calendar
POST/JWTContent.EditLumikha o mag-update ng mga curated calendar (batch)
DELETE/:idJWTContent.EditBurahin ang isang curated calendar

Mga Curated Event

Base path: /content/curatedEvents

MethodPathAuthPermissionPaglalarawan
GET/calendar/:curatedCalendarId?withoutEventsJWTKunin ang mga curated event para sa isang calendar (kasama ang mga detalye ng event at exception date maliban kung nakatakda ang ?withoutEvents)
GET/public/calendar/:churchId/:curatedCalendarIdPampublikoKunin ang mga pampublikong curated event para sa isang calendar
GET/:idJWTKunin ang isang curated event ayon sa ID
GET/JWTIlista ang lahat ng curated event
POST/JWTContent.EditLumikha o mag-update ng mga curated event. Sinusuportahan ang eventIds array para magdagdag ng partikular na mga event ng grupo
DELETE/:idJWTContent.EditBurahin ang isang curated event
DELETE/calendar/:curatedCalendarId/event/:eventIdJWTContent.EditAlisin ang isang partikular na event mula sa isang curated calendar
DELETE/calendar/:curatedCalendarId/group/:groupIdJWTContent.EditAlisin ang lahat ng event para sa isang grupo mula sa isang curated calendar

Mga File

Base path: /content/files

MethodPathAuthPermissionPaglalarawan
GET/:contentType/:contentIdJWTKunin ang mga file ayon sa uri ng nilalaman at content ID
GET/JWTIlista ang lahat ng file para sa website ng simbahan
GET/:idJWTKunin ang isang file ayon sa ID
POST/JWTContent.Edit*Mag-upload ng mga file (base64). *Pinapayagan din kung ang gumagamit ay miyembro ng grupong tumutugma sa contentId
POST/postUrlJWTContent.Edit*Kumuha ng pre-signed S3 upload URL. *Pinapayagan din para sa mga miyembro ng grupo. Maximum na 100MB bawat content item
DELETE/:idJWTContent.Edit*Burahin ang isang file at alisin mula sa storage. *Pinapayagan din para sa mga miyembro ng grupo

Base path: /content/gallery

MethodPathAuthPermissionPaglalarawan
GET/stock/:folderPampublikoIlista ang mga stock photo sa isang folder
GET/:folderJWTContent.EditIlista ang mga imahe ng gallery sa isang folder
POST/requestUploadJWTContent.EditKumuha ng pre-signed S3 upload URL para sa isang imahe ng gallery
DELETE/:folder/:imageJWTContent.EditBurahin ang isang imahe ng gallery

Mga Bibliya

Base path: /content/bibles

Lahat ng Bible endpoint ay pampubliko (walang kinakailangang authentication). Ang data ay kinukuha mula sa mga panlabas na pinagmulan at naka-cache nang lokal.

MethodPathAuthPermissionPaglalarawan
GET/PampublikoIlista ang lahat ng salin ng Bibliya (kinukuha mula sa pinagmulan kung walang laman ang cache)
GET/stats?startDate=&endDate=PampublikoKumuha ng estadistika ng paghahanap ng Bibliya para sa isang saklaw ng petsa
GET/availableTranslations/:sourcePampublikoIlista ang mga magagamit na salin mula sa isang pinagmulan (hal. api.bible)
GET/updateTranslationsPampublikoI-sync ang lahat ng salin mula sa lahat ng pinagmulan
GET/updateTranslations/:sourcePampublikoI-sync ang mga salin mula sa isang partikular na pinagmulan
GET/updateCopyrightsPampublikoI-update ang impormasyon ng copyright para sa mga salin na wala nito
GET/:translationKey/updateCopyrightPampublikoI-update ang copyright para sa isang partikular na salin
GET/:translationKey/search?query=&limit=PampublikoMaghanap ng mga talata sa isang salin
GET/:translationKey/booksPampublikoKumuha ng mga libro para sa isang salin (naka-cache nang lokal)
GET/:translationKey/:bookKey/chaptersPampublikoKumuha ng mga kabanata para sa isang libro (naka-cache nang lokal)
GET/:translationKey/chapters/:chapterKey/versesPampublikoKumuha ng mga talata para sa isang kabanata (naka-cache nang lokal)
GET/:translationKey/verses/:startVerseKey-:endVerseKeyPampublikoKumuha ng teksto ng talata para sa isang saklaw. Nagla-log ng mga paghahanap. Ang ilang salin ay hindi gumagamit ng caching para sa licensing

Halimbawa: Kumuha ng Teksto ng Talata

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

Mga Kanta

Base path: /content/songs

MethodPathAuthPermissionPaglalarawan
GET/search?q=JWTMaghanap ng mga kanta ayon sa query
GET/:idJWTKunin ang isang kanta ayon sa ID
GET/JWTContent.EditIlista ang lahat ng kanta
POST/JWTContent.EditLumikha o mag-update ng mga kanta (batch)
POST/importJWTMag-import ng mga kanta mula sa FreeShow (batch)
DELETE/:idJWTContent.EditBurahin ang isang kanta

Mga Detalye ng Kanta

Base path: /content/songDetails

Ang mga detalye ng kanta ay pandaigdig (hindi naka-scope sa simbahan). Ang mga ito ay kumakatawan sa canonical na metadata ng kanta na ibinahagi sa lahat ng simbahan.

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang detalye ng kanta ayon sa ID (pandaigdig)
GET/JWTIlista ang mga detalye ng kanta para sa simbahan
POST/createJWTLumikha ng detalye ng kanta mula sa PraiseCharts ID (nagbabalik ng umiiral kung nagawa na). Awtomatikong kinukuha ang metadata mula sa PraiseCharts at MusicBrainz
POST/JWTLumikha o mag-update ng mga detalye ng kanta (batch)

Base path: /content/songDetailLinks

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang link ng detalye ng kanta ayon sa ID
GET/songDetail/:songDetailIdJWTKunin ang lahat ng link para sa isang detalye ng kanta
POST/JWTLumikha o mag-update ng mga link ng detalye ng kanta (batch). Awtomatikong kinukuha ang MusicBrainz data kung naka-link
DELETE/:idJWTBurahin ang isang link ng detalye ng kanta

Mga Arrangement

Base path: /content/arrangements

MethodPathAuthPermissionPaglalarawan
GET/:idJWTKunin ang isang arrangement ayon sa ID
GET/song/:songIdJWTContent.EditKunin ang mga arrangement para sa isang kanta
GET/songDetail/:songDetailIdJWTContent.EditKunin ang mga arrangement para sa isang detalye ng kanta
GET/JWTContent.EditIlista ang lahat ng arrangement
POST/JWTContent.EditLumikha o mag-update ng mga arrangement (batch)
POST/freeShow/missingJWTHanapin ang mga FreeShow ID na wala sa simbahan. Body: { freeShowIds: string[] }
DELETE/:idJWTContent.EditBurahin ang isang arrangement (binubura din ang mga key; binubura ang kanta kung walang natitirang arrangement)

Mga Key ng Arrangement

Base path: /content/arrangementKeys

MethodPathAuthPermissionPaglalarawan
GET/presenter/:churchId/:idPampublikoKunin ang arrangement key na may buong data ng kanta para sa presenter view
GET/:idJWTKunin ang isang arrangement key ayon sa ID
GET/arrangement/:arrangementIdJWTContent.EditKunin ang mga key para sa isang arrangement
GET/JWTContent.EditIlista ang lahat ng arrangement key
POST/JWTContent.EditLumikha o mag-update ng mga arrangement key (batch)
DELETE/:idJWTContent.EditBurahin ang isang arrangement key

Mga Setting

Base path: /content/settings

MethodPathAuthPermissionPaglalarawan
GET/myJWTKunin ang mga setting ng kasalukuyang gumagamit
GET/JWTSettings.EditKunin ang lahat ng setting para sa simbahan
GET/public/:churchIdPampublikoKunin ang mga pampublikong setting para sa isang simbahan (ibinalik bilang mga key-value pair)
GET/imports?playlistId=&channelId=&type=JWTSettings.EditKunin ang mga setting ng auto-import (mga YouTube/Vimeo channel ID)
POST/myJWTI-save ang mga setting ng antas ng gumagamit (sinusuportahan ang base64 na pag-upload ng imahe)
POST/JWTSettings.EditI-save ang mga setting ng antas ng simbahan (sinusuportahan ang base64 na pag-upload ng imahe)
DELETE/my/:idJWTBurahin ang isang setting ng gumagamit

Preview

Base path: /content/preview

MethodPathAuthPermissionPaglalarawan
GET/data/:keyPampublikoI-load ang data ng streaming preview para sa isang simbahan ayon sa subdomain key (mga tab, link, serbisyo, sermon)

Base path: /content/stock

MethodPathAuthPermissionPaglalarawan
POST/searchPampublikoMaghanap ng mga Pexels stock photo. Body: { term: "church" }

PraiseCharts

Base path: /content/praiseCharts

Integrasyon sa PraiseCharts para sa pagtuklas ng mga kanta sa pagsamba at pag-download ng mga sheet music.

MethodPathAuthPermissionPaglalarawan
GET/raw/:idJWTKunin ang raw na PraiseCharts data para sa isang kanta
GET/hasAccountJWTSuriin kung ang gumagamit ay may naka-link na PraiseCharts account
GET/search?q=JWTMaghanap sa PraiseCharts catalog
GET/products/:id?keys=JWTKunin ang mga produkto para sa isang kanta (mula sa library kung naka-authenticate, kung hindi mula sa catalog)
GET/arrangement/raw/:id?keys=JWTKunin ang raw na data ng arrangement mula sa library
GET/download?skus=&keys=&file_name=JWTMag-download ng file mula sa PraiseCharts (PDF o ZIP). Nagbabalik ng { redirectUrl }
GET/authUrl?returnUrl=PampublikoKunin ang OAuth authorization URL para sa PraiseCharts
GET/access?verifier=&token=&secret=JWTIpagpalit ang OAuth verifier para sa access token at i-save sa mga setting ng gumagamit
GET/libraryJWTI-browse ang PraiseCharts library ng gumagamit

Support

Base path: /content/support

MethodPathAuthPermissionPaglalarawan
POST/createAudioPampublikoI-convert ang SSML sa MP3 audio gamit ang AWS Polly. Body: { ssml: "<speak>...</speak>" }

Mga Kaugnay na Pahina