Zum Hauptinhalt springen

Inhalts-Endpunkte

Das Inhaltsmodul verwaltet Website-Seiten, Abschnitte, Elemente, Blöcke, Blogbeiträge, Weiterleitungen, Predigten, Wiedergabelisten, Streaming-Dienste, Veranstaltungen, kuratierte Kalender, Dateien, Galerien, Bibelübersetzungen und Bibelvers-Suchen, Lieder, Arrangements, globale Stile, Stockfotos und Einstellungen. Es ist das größte Modul der API und treibt das CMS, Medien- und Streaming-Funktionen, die Gottesdienstplanung und die Bibelfunktionen in allen ChurchApps-Anwendungen an.

Basispfad: /content

Seiten​

Basispfad: /content/pages

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:churchId/tree?url=&id=Öffentlich—Vollständigen Seitenbaum (Abschnitte, Elemente, Blöcke) anhand von URL oder ID laden. Entfernt interne IDs, wenn über die URL abgerufen wird. URL-basierte Abrufe erzwingen pages.visibility — eine eingeschränkte Seite gibt { restricted: true, visibility } zurück, sofern das (optionale) JWT die Sperre nicht erfüllt
GET/public/:churchIdÖffentlich—Öffentliche Seiten auflisten (url, title, metaDescription); nur visibility = everyone
GET/:idJWT—Eine Seite anhand der ID abrufen
GET/JWT—Alle Seiten der Kirche auflisten
POST/duplicate/:idJWTContent.EditEine Seite mit allen Abschnitten und Elementen duplizieren
POST/temp/aiJWTContent.EditEine KI-generierte Seite speichern (Seite, Abschnitte und Elemente in einem Aufruf)
POST/importTreeJWTContent.EditEine Seite aus einem verschachtelten Baum erstellen (title, url, sections[].elements[]…). Wird immer unter der Kirche des Aufrufers eingefügt; IDs im Body werden ignoriert. Zeilen müssen ihre column-Untereinträge enthalten. Maximal 30 Abschnitte / 500 Elemente
POST/JWTContent.EditSeiten erstellen oder aktualisieren (Stapelverarbeitung)
DELETE/:idJWTContent.EditEine Seite löschen

Beispiel: Seitenbaum 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" } }
]
}
]
}

Abschnitte​

Basispfad: /content/sections

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Einen Abschnitt anhand der ID abrufen
POST/duplicate/:id?convertToBlock=JWTContent.EditEinen Abschnitt duplizieren oder in einen wiederverwendbaren Block umwandeln
POST/JWTContent.EditAbschnitte erstellen oder aktualisieren (Stapelverarbeitung). Aktualisiert die Sortierreihenfolge automatisch
DELETE/:idJWTContent.EditEinen Abschnitt löschen (aktualisiert die Sortierreihenfolge automatisch)

Elemente​

Basispfad: /content/elements

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Ein Element anhand der ID abrufen
POST/duplicate/:idJWTContent.EditEin Element mit allen untergeordneten Elementen duplizieren
POST/JWTContent.EditElemente erstellen oder aktualisieren (Stapelverarbeitung). Verwaltet Zeilenspalten und Karussell-Folien automatisch
DELETE/:idJWTContent.EditEin Element löschen

Blöcke​

Basispfad: /content/blocks

Erweitert die Standard-CRUD-Funktionen (GET /:id, GET /, POST /, DELETE /:id aus der Basisklasse mit der Berechtigung Content.Edit für Schreibzugriffe).

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Einen Block anhand der ID abrufen
GET/JWT—Alle Blöcke auflisten
GET/:churchId/tree/:idÖffentlich—Vollständigen Blockbaum mit Abschnitten und Elementen laden
GET/blockType/:blockTypeJWT—Blöcke nach Typ laden (z. B. footerBlock, elementBlock)
GET/public/footer/:churchIdÖffentlich—Fußzeilen-Blockbaum einer Kirche laden
POST/JWTContent.EditBlöcke erstellen oder aktualisieren
DELETE/:idJWTContent.EditEinen Block löschen

Basispfad: /content/links

Erweitert die Standard-CRUD-Funktionen (GET /:id, GET /, POST /, DELETE /:id aus der Basisklasse mit der Berechtigung Content.Edit für Schreibzugriffe).

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Einen Link anhand der ID abrufen
GET/JWT—Alle Links auflisten. Optionaler Filter ?category=. Wird nach dem Speichern automatisch sortiert
GET/church/:churchId/filtered?category=JWT—Links nach Sichtbarkeit gefiltert laden (everyone, visitors, members, staff, groups)
GET/church/:churchId?category=Öffentlich—Links einer Kirche nach Kategorie laden (öffentlich)
POST/JWTContent.EditLinks erstellen oder aktualisieren (Stapelverarbeitung). Sortiert automatisch nach Kategorie
DELETE/:idJWTContent.EditEinen Link löschen

Globale Stile​

Basispfad: /content/globalStyles

Erweitert die Standard-CRUD-Funktionen (POST /, DELETE /:id aus der Basisklasse mit der Berechtigung Content.Edit für Schreibzugriffe).

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/church/:churchIdÖffentlich—Globale Stile einer Kirche laden (gibt Standardwerte zurück, wenn keine gesetzt sind)
GET/JWT—Globale Stile der authentifizierten Kirche laden
POST/JWTContent.EditGlobale Stile erstellen oder aktualisieren
DELETE/:idJWTContent.EditGlobale Stile löschen

Seitenverlauf​

Basispfad: /content/pageHistory

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/page/:pageIdJWTContent.EditVerlaufseinträge einer Seite auflisten
GET/block/:blockIdJWTContent.EditVerlaufseinträge eines Blocks auflisten
GET/:idJWTContent.EditEinen Verlaufseintrag anhand der ID abrufen
POST/JWTContent.EditEinen Snapshot einer Seite bzw. eines Blocks speichern. Entfernt regelmäßig Einträge, die älter als 30 Tage sind
POST/restore/:idJWTContent.EditEine Seite bzw. einen Block aus einem Verlaufs-Snapshot wiederherstellen (löscht den aktuellen Inhalt und erstellt ihn aus dem Snapshot neu)
POST/restoreSnapshotJWTContent.EditAus einem eingebetteten Snapshot-Objekt wiederherstellen. Body: { pageId, blockId, snapshot }

Beiträge (Blog)​

Basispfad: /content/posts

Blogbeiträge sind eigenständige Datensätze: title, slug (pro Kirche eindeutig), excerpt, content (Markdown-Text), authorId, photoUrl, publishDate, category und tags. Ein Beitrag ist veröffentlicht, sobald publishDate gesetzt und in der Vergangenheit ist. Lese-Endpunkte ergänzen jeden Beitrag um authorName, das aus authorId ermittelt wird. Siehe Architektur des Website-Builders.

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/public/:churchId?category=&tag=&page=&pageSize=Öffentlich—Veröffentlichte Beiträge seitenweise auflisten (maximal 50 pro Seite)
GET/public/:churchId/categoriesÖffentlich—Verschiedene Kategorien veröffentlichter Beiträge
GET/public/:churchId/slug/:slugÖffentlich—Einen veröffentlichten Beitrag anhand des Slugs abrufen
GET/rss/:churchId?siteUrl=Öffentlich—RSS-2.0-Feed veröffentlichter Beiträge (Links werden als {siteUrl}/blog/{slug} erstellt)
GET/:idJWT—Einen Beitrag anhand der ID abrufen
GET/JWT—Alle Beiträge der Kirche auflisten
POST/JWTContent.EditBeiträge erstellen oder aktualisieren (Stapelverarbeitung)
DELETE/:idJWTContent.EditEinen Beitrag löschen

Weiterleitungen​

Basispfad: /content/redirects

URL-Weiterleitungen pro Kirche (fromPath → toPath), maximal 200 pro Kirche. Pfade werden normalisiert (Kleinschreibung, führender Schrägstrich, kein abschließender Schrägstrich), und fromPath ist pro Kirche eindeutig. B1App löst diese bei Anfragen auf, die sonst einen 404-Fehler erzeugen würden, und sendet eine HTTP-308-Antwort.

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/public/:churchId?path=Öffentlich—Einen Pfad auflösen (oder alle Weiterleitungen auflisten, wenn path weggelassen wird)
GET/:idJWT—Eine Weiterleitung anhand der ID abrufen
GET/JWT—Alle Weiterleitungen der Kirche auflisten
POST/JWTContent.EditWeiterleitungen erstellen oder aktualisieren. Lehnt fromPath = toPath ab und erzwingt die Obergrenze von 200 Zeilen
DELETE/:idJWTContent.EditEine Weiterleitung löschen

Predigten​

Basispfad: /content/sermons

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/public/freeshowSampleJWT—Eine Beispielstruktur einer FreeShow-Wiedergabeliste abrufen
GET/public/tvWrapper/:churchIdJWT—TV-App-Wrapper mit Quellen für Predigt, Lektion und FreeShow abrufen
GET/public/tvFeed/:churchId/:sermonIdÖffentlich—Eine einzelne Predigt als TV-Feed-Wiedergabeliste abrufen
GET/public/tvFeed/:churchIdÖffentlich—Alle öffentlichen Wiedergabelisten/Predigten als TV-Feed abrufen
GET/public/:churchIdÖffentlich—Alle öffentlichen Predigten einer Kirche auflisten
GET/timeline?sermonIds=JWT—Zeitleistendaten für Predigten laden
GET/lookup?videoType=&videoData=Öffentlich—Predigt-Metadaten von YouTube oder Vimeo nachschlagen
GET/socialSuggestions?youtubeVideoId=JWT—KI-generierte Vorschläge für Social-Media-Beiträge aus den Untertiteln einer Predigt erstellen
GET/outline?url=&title=&author=JWT—KI-generierte Lektionsgliederung aus einer URL erstellen
GET/youtubeImport/:channelIdJWT—Videos aus einem YouTube-Kanal importieren. HTML-Entitäten, die die YouTube-Suche-API in Titel und Beschreibungen einfügt (etwa & und '), werden dekodiert
GET/vimeoImport/:channelIdJWT—Videos aus einem Vimeo-Kanal importieren
GET/:idJWT—Eine Predigt anhand der ID abrufen
GET/JWT—Alle Predigten auflisten
POST/JWTStreamingServices.EditPredigten erstellen oder aktualisieren. Akzeptiert ein Array oder ein einzelnes Predigtobjekt (gibt immer ein Array zurück); ein leerer Body ergibt 400. Unterstützt den Upload von Miniaturbildern als Base64
DELETE/:idJWTStreamingServices.EditEine Predigt löschen

Beispiel: Eine YouTube-Predigt nachschlagen​

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

Wiedergabelisten​

Basispfad: /content/playlists

Erweitert die Standard-CRUD-Funktionen (GET /:id, GET /, DELETE /:id aus der Basisklasse mit der Berechtigung StreamingServices.Edit für Schreibzugriffe).

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Eine Wiedergabeliste anhand der ID abrufen
GET/JWT—Alle Wiedergabelisten auflisten
GET/public/:churchIdÖffentlich—Alle öffentlichen Wiedergabelisten einer Kirche auflisten
POST/JWTStreamingServices.EditWiedergabelisten erstellen oder aktualisieren (Stapelverarbeitung, unterstützt den Upload von Miniaturbildern als Base64)
DELETE/:idJWTStreamingServices.EditEine Wiedergabeliste löschen

Streaming-Dienste​

Basispfad: /content/streamingServices

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:id/hostChatJWTChat.HostVerschlüsselte ID des Host-Chatraums für einen Dienst abrufen
GET/JWT—Alle Streaming-Dienste auflisten. Entfernt abgelaufene, nicht wiederkehrende Dienste automatisch und setzt wiederkehrende Dienste weiter
POST/JWTStreamingServices.EditStreaming-Dienste erstellen oder aktualisieren (Stapelverarbeitung)
DELETE/:idJWTStreamingServices.EditEinen Streaming-Dienst löschen (entfernt außerdem gesperrte IP-Adressen)

Veranstaltungen​

Basispfad: /content/events

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/timeline/group/:groupId?eventIds=JWT—Zeitleistenereignisse für eine Gruppe laden (enthält Ausnahmetermine, damit gelöschte Vorkommen übersprungen werden können)
GET/timeline?eventIds=JWT—Zeitleistenereignisse für die Gruppen des aktuellen Benutzers laden (enthält Ausnahmetermine)
GET/subscribe?churchId=&groupId=&curatedCalendarId=Öffentlich—Veranstaltungen als ICS-Kalender-Feed abonnieren
GET/group/:groupIdJWT—Veranstaltungen einer Gruppe abrufen (enthält Ausnahmetermine)
GET/public/group/:churchId/:groupIdÖffentlich—Öffentliche Veranstaltungen einer Gruppe abrufen
GET/public/:churchId/:idÖffentlich—Eine Veranstaltung für ihre öffentliche Seite abrufen, mit roomNames (Räume aus Buchungen, die nicht abgelehnt wurden). Gibt null für ausstehende oder abgelehnte Veranstaltungen sowie für private Veranstaltungen zurück, die keine Anmeldungen annehmen
GET/public/:churchId/:id/icalÖffentlich—Diese einzelne Veranstaltung als .ics-Datei herunterladen (text/calendar, Ausnahmetermine werden angewendet). 404, wenn die Veranstaltung nach denselben Regeln ausgeblendet ist
GET/:idJWT—Eine Veranstaltung anhand der ID abrufen
POST/JWT—Veranstaltungen erstellen oder aktualisieren (Stapelverarbeitung)
DELETE/:idJWTContent.Edit, Calendars.Admin oder GruppenleiterEine Veranstaltung und ihre Buchungen löschen. Leiter der Gruppe der Veranstaltung dürfen sie löschen, und ein Antragsteller kann seine eigene ausstehende Anfrage zurückziehen

Veranstaltungsdatensätze enthalten photoUrl (das Veranstaltungsfoto im Format 16:9, das auf der öffentlichen Veranstaltungsseite und in den Kacheln für kommende Veranstaltungen angezeigt wird), tags (durch Kommas getrennt; wird vom Kalender-Element der Website für den Tag-Filter genutzt) sowie notesViewRole / notesPostRole (staff, wenn null, leaders oder members), die den Zugriff auf die Unterhaltung eventNote der Veranstaltung steuern — siehe Zugriffssteuerung für Gruppen- und Veranstaltungsnotizen. Antworten für öffentliche kuratierte Veranstaltungen enthalten ebenfalls photoUrl und tags jeder Veranstaltung.

Veranstaltungsausnahmen​

Basispfad: /content/eventExceptions

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Eine Veranstaltungsausnahme anhand der ID abrufen
POST/JWTContent.Edit, Calendars.Admin oder GruppenleiterVeranstaltungsausnahmen erstellen oder aktualisieren (Stapelverarbeitung). Leiter dürfen nur Ausnahmen für Veranstaltungen in Gruppen hinzufügen, die sie leiten
DELETE/:idJWTContent.Edit, Calendars.Admin oder GruppenleiterEine Veranstaltungsausnahme löschen

Kuratierte Kalender​

Basispfad: /content/curatedCalendars

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Einen kuratierten Kalender anhand der ID abrufen
GET/JWT—Alle kuratierten Kalender auflisten
POST/JWTContent.EditKuratierte Kalender erstellen oder aktualisieren (Stapelverarbeitung)
DELETE/:idJWTContent.EditEinen kuratierten Kalender löschen

Kuratierte Veranstaltungen​

Basispfad: /content/curatedEvents

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/calendar/:curatedCalendarId?withoutEventsJWT—Kuratierte Veranstaltungen eines Kalenders abrufen (enthält Veranstaltungsdetails und Ausnahmetermine, sofern nicht ?withoutEvents gesetzt ist)
GET/public/calendar/:churchId/:curatedCalendarIdÖffentlich—Öffentliche kuratierte Veranstaltungen eines Kalenders abrufen
GET/:idJWT—Eine kuratierte Veranstaltung anhand der ID abrufen
GET/JWT—Alle kuratierten Veranstaltungen auflisten
POST/JWTContent.EditKuratierte Veranstaltungen erstellen oder aktualisieren. Unterstützt das Array eventIds, um bestimmte Gruppenveranstaltungen hinzuzufügen
DELETE/:idJWTContent.EditEine kuratierte Veranstaltung löschen
DELETE/calendar/:curatedCalendarId/event/:eventIdJWTContent.EditEine bestimmte Veranstaltung aus einem kuratierten Kalender entfernen
DELETE/calendar/:curatedCalendarId/group/:groupIdJWTContent.EditAlle Veranstaltungen einer Gruppe aus einem kuratierten Kalender entfernen

Dateien​

Basispfad: /content/files

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:contentType/:contentIdJWT—Dateien nach Inhaltstyp und Inhalts-ID abrufen
GET/JWT—Alle Dateien der Kirchen-Website auflisten
GET/:idJWT—Eine Datei anhand der ID abrufen
POST/JWTContent.Edit*Dateien hochladen (Base64). *Auch erlaubt, wenn der Benutzer Mitglied der Gruppe ist, die zur contentId gehört
POST/postUrlJWTContent.Edit*Eine vorsignierte S3-Upload-URL abrufen. *Auch für Gruppenmitglieder erlaubt. Maximal 100 MB pro Inhaltselement
DELETE/:idJWTContent.Edit*Eine Datei löschen und aus dem Speicher entfernen. *Auch für Gruppenmitglieder erlaubt

Galerie​

Basispfad: /content/gallery

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/stock/:folderÖffentlich—Stockfotos in einem Ordner auflisten
GET/:folderJWTContent.EditGaleriebilder in einem Ordner auflisten
POST/requestUploadJWTContent.EditEine vorsignierte S3-Upload-URL für ein Galeriebild abrufen
DELETE/:folder/:imageJWTContent.EditEin Galeriebild löschen

Bibeln​

Basispfad: /content/bibles

Alle Bibel-Endpunkte sind öffentlich (keine Authentifizierung erforderlich). Die Daten werden aus externen Quellen abgerufen und lokal zwischengespeichert. Anfragen an api.bible laufen nach 15 Sekunden ab; eine Zeitüberschreitung gibt 504 zurück.

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/Öffentlich—Alle Bibelübersetzungen auflisten (wird aus der Quelle abgerufen, wenn der Cache leer ist)
GET/stats?startDate=&endDate=Öffentlich—Bibel-Nachschlagestatistiken für einen Datumsbereich abrufen
GET/availableTranslations/:sourceÖffentlich—Verfügbare Übersetzungen einer Quelle auflisten (z. B. api.bible)
GET/updateTranslationsÖffentlich—Alle Übersetzungen aus allen Quellen synchronisieren
GET/updateTranslations/:sourceÖffentlich—Übersetzungen einer bestimmten Quelle synchronisieren
GET/updateCopyrightsÖffentlich—Urheberrechtsinformationen für Übersetzungen aktualisieren, bei denen sie fehlen
GET/:translationKey/updateCopyrightÖffentlich—Urheberrecht einer bestimmten Übersetzung aktualisieren
GET/:translationKey/search?query=&limit=Öffentlich—Verse in einer Übersetzung durchsuchen
GET/:translationKey/booksÖffentlich—Bücher einer Übersetzung abrufen (wird lokal zwischengespeichert)
GET/:translationKey/:bookKey/chaptersÖffentlich—Kapitel eines Buches abrufen (wird lokal zwischengespeichert)
GET/:translationKey/chapters/:chapterKey/versesÖffentlich—Verse eines Kapitels abrufen (wird lokal zwischengespeichert)
GET/:translationKey/verses/:startVerseKey-:endVerseKeyÖffentlich—Verstext für einen Bereich abrufen. Protokolliert Abfragen. Einige Übersetzungen umgehen den Cache aus lizenzrechtlichen Gründen

Beispiel: Versttext abrufen​

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

Lieder​

Basispfad: /content/songs

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/search?q=JWT—Lieder nach Suchbegriff durchsuchen
GET/:idJWT—Ein Lied anhand der ID abrufen
GET/JWTContent.EditAlle Lieder auflisten
POST/JWTContent.EditLieder erstellen oder aktualisieren (Stapelverarbeitung)
POST/importJWT—Lieder aus FreeShow importieren (Stapelverarbeitung)
DELETE/:idJWTContent.EditEin Lied löschen

Liedinformationen​

Basispfad: /content/songDetails

Liedinformationen sind global (nicht an eine Kirche gebunden). Sie stellen kanonische Liedmetadaten dar, die von Kirchen gemeinsam genutzt werden.

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Liedinformationen anhand der ID abrufen (global)
GET/JWT—Liedinformationen der Kirche auflisten
POST/createJWT—Liedinformationen anhand einer PraiseCharts-ID anlegen (gibt das vorhandene Element zurück, wenn es bereits angelegt wurde). Ruft Metadaten automatisch von PraiseCharts und MusicBrainz ab
POST/JWT—Liedinformationen erstellen oder aktualisieren (Stapelverarbeitung)

Verknüpfungen von Liedinformationen​

Basispfad: /content/songDetailLinks

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Eine Verknüpfung von Liedinformationen anhand der ID abrufen
GET/songDetail/:songDetailIdJWT—Alle Verknüpfungen einer Liedinformation abrufen
POST/JWT—Verknüpfungen von Liedinformationen erstellen oder aktualisieren (Stapelverarbeitung). Ruft MusicBrainz-Daten automatisch ab, wenn eine Verknüpfung besteht
DELETE/:idJWT—Eine Verknüpfung von Liedinformationen löschen

Arrangements​

Basispfad: /content/arrangements

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/:idJWT—Ein Arrangement anhand der ID abrufen
GET/song/:songIdJWTContent.EditArrangements eines Liedes abrufen
GET/songDetail/:songDetailIdJWTContent.EditArrangements einer Liedinformation abrufen
GET/JWTContent.EditAlle Arrangements auflisten
POST/JWTContent.EditArrangements erstellen oder aktualisieren (Stapelverarbeitung)
POST/freeShow/missingJWT—FreeShow-IDs ermitteln, die in der Kirche nicht vorhanden sind. Body: { freeShowIds: string[] }
DELETE/:idJWTContent.EditEin Arrangement löschen (löscht außerdem die Tonarten; löscht das Lied, wenn keine Arrangements mehr übrig sind)

Arrangement-Tonarten​

Basispfad: /content/arrangementKeys

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/presenter/:churchId/:idÖffentlich—Arrangement-Tonart mit vollständigen Liededaten für die Präsentationsansicht abrufen
GET/:idJWT—Eine Arrangement-Tonart anhand der ID abrufen
GET/arrangement/:arrangementIdJWTContent.EditTonarten eines Arrangements abrufen
GET/JWTContent.EditAlle Arrangement-Tonarten auflisten
POST/JWTContent.EditArrangement-Tonarten erstellen oder aktualisieren (Stapelverarbeitung)
DELETE/:idJWTContent.EditEine Arrangement-Tonart löschen

Einstellungen​

Basispfad: /content/settings

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/myJWT—Einstellungen des aktuellen Benutzers abrufen
GET/JWTSettings.EditAlle Einstellungen der Kirche abrufen
GET/public/:churchIdÖffentlich—Öffentliche Einstellungen einer Kirche abrufen (als Schlüssel-Wert-Paare zurückgegeben)
POST/myJWT—Benutzereinstellungen speichern (unterstützt den Upload von Bildern als Base64)
POST/JWTSettings.EditKircheneinstellungen speichern (unterstützt den Upload von Bildern als Base64)
DELETE/my/:idJWT—Eine Benutzereinstellung löschen

Vorschau​

Basispfad: /content/preview

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/data/:keyÖffentlich—Daten der Streaming-Vorschau einer Kirche anhand des Subdomain-Schlüssels laden (Tabs, Links, Dienste, Predigten)

Galerie (Stockfotos)​

Basispfad: /content/stock

MethodePfadAuthentifizierungBerechtigungBeschreibung
POST/searchÖffentlich—Pexels-Stockfotos durchsuchen. Body: { term: "church" }

PraiseCharts​

Basispfad: /content/praiseCharts

Integration mit PraiseCharts zum Entdecken von Lobpreisliedern und zum Herunterladen von Notenblättern.

MethodePfadAuthentifizierungBerechtigungBeschreibung
GET/raw/:idJWT—Rohdaten von PraiseCharts zu einem Lied abrufen
GET/hasAccountJWT—Prüfen, ob der Benutzer ein verknüpftes PraiseCharts-Konto hat
GET/search?q=JWT—Den PraiseCharts-Katalog durchsuchen
GET/products/:id?keys=JWT—Produkte zu einem Lied abrufen (aus der Bibliothek, wenn angemeldet, sonst aus dem Katalog)
GET/arrangement/raw/:id?keys=JWT—Rohdaten eines Arrangements aus der Bibliothek abrufen
GET/download?skus=&keys=&file_name=JWT—Eine Datei von PraiseCharts herunterladen (PDF oder ZIP). Gibt { redirectUrl } zurück
GET/authUrl?returnUrl=Öffentlich—OAuth-Autorisierungs-URL für PraiseCharts abrufen
GET/access?verifier=&token=&secret=JWT—OAuth-Verifizierer gegen ein Zugriffstoken tauschen und in den Benutzereinstellungen speichern
GET/libraryJWT—Die PraiseCharts-Bibliothek des Benutzers durchsuchen

Support​

Basispfad: /content/support

MethodePfadAuthentifizierungBerechtigungBeschreibung
POST/createAudioÖffentlich—SSML mit AWS Polly in eine MP3-Audiodatei umwandeln. Body: { ssml: "<speak>...</speak>" }

Verwandte Seiten​