Перейти к основному содержимому

Эндпоинты контента

Модуль контента управляет страницами сайта, разделами, элементами, блоками, записями блога, перенаправлениями, проповедями, плейлистами, потоковыми службами, событиями, курируемыми календарями, файлами, галереями, переводами Библии и поиском стихов, песнями, аранжировками, глобальными стилями, стоковыми фотографиями и настройками. Это самый крупный модуль API. Он обеспечивает работу CMS, медиа и потокового вещания, планирования богослужений и функций Библии во всех приложениях ChurchApps.

Базовый путь: /content

Страницы​

Базовый путь: /content/pages

МетодПутьАвторизацияРазрешениеОписание
GET/:churchId/tree?url=&id=Публичный—Загрузить полное дерево страницы (разделы, элементы, блоки) по URL или ID. При запросе по URL внутренние ID удаляются. Запросы по URL учитывают pages.visibility — страница с ограниченным доступом возвращает { restricted: true, visibility }, если только (необязательный) JWT не удовлетворяет условию доступа
GET/public/:churchIdПубличный—Список публичных страниц (url, title, metaDescription); только с visibility = everyone
GET/:idJWT—Получить страницу по ID
GET/JWT—Получить все страницы церкви
POST/duplicate/:idJWTContent.EditДублировать страницу со всеми разделами и элементами
POST/temp/aiJWTContent.EditСохранить страницу, созданную ИИ (страница, разделы и элементы одним вызовом)
POST/importTreeJWTContent.EditСоздать страницу из вложенного дерева (title, url, sections[].elements[]…). Всегда вставляет данные в церковь вызывающего; ID в теле запроса игнорируются. Строки должны включать дочерние column. Максимум 30 разделов / 500 элементов
POST/JWTContent.EditСоздать или обновить страницы (пакетно)
DELETE/:idJWTContent.EditУдалить страницу

Пример: загрузка дерева страницы​

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

Разделы​

Базовый путь: /content/sections

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить раздел по ID
POST/duplicate/:id?convertToBlock=JWTContent.EditДублировать раздел или преобразовать его в повторно используемый блок
POST/JWTContent.EditСоздать или обновить разделы (пакетно). Порядок сортировки обновляется автоматически
DELETE/:idJWTContent.EditУдалить раздел (порядок сортировки обновляется автоматически)

Элементы​

Базовый путь: /content/elements

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить элемент по ID
POST/duplicate/:idJWTContent.EditДублировать элемент со всеми дочерними объектами
POST/JWTContent.EditСоздать или обновить элементы (пакетно). Автоматически управляет колонками строк и слайдами карусели
DELETE/:idJWTContent.EditУдалить элемент

Блоки​

Базовый путь: /content/blocks

Расширяет стандартный CRUD (GET /:id, GET /, POST /, DELETE /:id из базового класса; для записи требуется разрешение Content.Edit).

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить блок по ID
GET/JWT—Получить все блоки
GET/:churchId/tree/:idПубличный—Загрузить полное дерево блока с разделами и элементами
GET/blockType/:blockTypeJWT—Загрузить блоки по типу (например, footerBlock, elementBlock)
GET/public/footer/:churchIdПубличный—Загрузить дерево блока подвала для церкви
POST/JWTContent.EditСоздать или обновить блоки
DELETE/:idJWTContent.EditУдалить блок

Ссылки​

Базовый путь: /content/links

Расширяет стандартный CRUD (GET /:id, GET /, POST /, DELETE /:id из базового класса; для записи требуется разрешение Content.Edit).

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить ссылку по ID
GET/JWT—Список всех ссылок. Необязательный фильтр ?category=. Автоматически сортируется после сохранения
GET/church/:churchId/filtered?category=JWT—Загрузить ссылки, отфильтрованные по видимости (everyone, visitors, members, staff, groups)
GET/church/:churchId?category=Публичный—Загрузить ссылки церкви по категории (публично)
POST/JWTContent.EditСоздать или обновить ссылки (пакетно). Автоматически сортирует по категории
DELETE/:idJWTContent.EditУдалить ссылку

Глобальные стили​

Базовый путь: /content/globalStyles

Расширяет стандартный CRUD (POST /, DELETE /:id из базового класса; для записи требуется разрешение Content.Edit).

МетодПутьАвторизацияРазрешениеОписание
GET/church/:churchIdПубличный—Загрузить глобальные стили церкви (возвращает значения по умолчанию, если они не заданы)
GET/JWT—Загрузить глобальные стили для аутентифицированной церкви
POST/JWTContent.EditСоздать или обновить глобальные стили
DELETE/:idJWTContent.EditУдалить глобальные стили

История страниц​

Базовый путь: /content/pageHistory

МетодПутьАвторизацияРазрешениеОписание
GET/page/:pageIdJWTContent.EditСписок записей истории для страницы
GET/block/:blockIdJWTContent.EditСписок записей истории для блока
GET/:idJWTContent.EditПолучить запись истории по ID
POST/JWTContent.EditСохранить снимок страницы или блока. Периодически удаляет записи старше 30 дней
POST/restore/:idJWTContent.EditВосстановить страницу или блок из снимка истории (удаляет текущее содержимое и создаёт его заново из снимка)
POST/restoreSnapshotJWTContent.EditВосстановить из встроенного объекта снимка. Тело: { pageId, blockId, snapshot }

Записи (блог)​

Базовый путь: /content/posts

Записи блога хранятся как отдельные строки: title, slug (уникален для каждой церкви), excerpt, content (тело в формате markdown), authorId, photoUrl, publishDate, category и tags. Запись опубликована, как только задана дата publishDate и она находится в прошлом. Эндпоинты чтения дополняют каждую запись полем authorName, полученным по authorId. См. Архитектура конструктора сайтов.

МетодПутьАвторизацияРазрешениеОписание
GET/public/:churchId?category=&tag=&page=&pageSize=Публичный—Список опубликованных записей с постраничной навигацией (максимум 50 на страницу)
GET/public/:churchId/categoriesПубличный—Уникальные категории среди опубликованных записей
GET/public/:churchId/slug/:slugПубличный—Получить опубликованную запись по slug
GET/rss/:churchId?siteUrl=Публичный—RSS 2.0 лента опубликованных записей (ссылки формируются как {siteUrl}/blog/{slug})
GET/:idJWT—Получить запись по ID
GET/JWT—Список всех записей церкви
POST/JWTContent.EditСоздать или обновить записи (пакетно)
DELETE/:idJWTContent.EditУдалить запись

Перенаправления​

Базовый путь: /content/redirects

URL-перенаправления для каждой церкви (fromPath → toPath), не более 200 на церковь. Пути нормализуются (приводятся к нижнему регистру, с ведущим слэшем, без завершающего слэша), а fromPath уникален для каждой церкви. B1App обрабатывает их при запросах, которые привели бы к 404, и отвечает HTTP 308.

МетодПутьАвторизацияРазрешениеОписание
GET/public/:churchId?path=Публичный—Определить перенаправление для пути (или вернуть все перенаправления, если path не указан)
GET/:idJWT—Получить перенаправление по ID
GET/JWT—Список всех перенаправлений церкви
POST/JWTContent.EditСоздать или обновить перенаправления. Отклоняет fromPath = toPath и соблюдает ограничение в 200 записей
DELETE/:idJWTContent.EditУдалить перенаправление

Проповеди​

Базовый путь: /content/sermons

МетодПутьАвторизацияРазрешениеОписание
GET/public/freeshowSampleJWT—Получить пример структуры плейлиста FreeShow
GET/public/tvWrapper/:churchIdJWT—Получить обёртку для ТВ-приложения с источниками проповедей, уроков и FreeShow
GET/public/tvFeed/:churchId/:sermonIdПубличный—Получить одну проповедь как плейлист для ТВ-ленты
GET/public/tvFeed/:churchIdПубличный—Получить все публичные плейлисты/проповеди как ТВ-ленту
GET/public/:churchIdПубличный—Список всех публичных проповедей церкви
GET/timeline?sermonIds=JWT—Загрузить данные временной шкалы для проповедей
GET/lookup?videoType=&videoData=Публичный—Найти метаданные проповеди на YouTube или Vimeo
GET/socialSuggestions?youtubeVideoId=JWT—Сгенерировать с помощью ИИ варианты постов для соцсетей по субтитрам проповеди
GET/outline?url=&title=&author=JWT—Сгенерировать с помощью ИИ план урока по URL
GET/youtubeImport/:channelIdJWT—Импортировать видео из канала YouTube. HTML-сущности, которые API поиска YouTube использует в заголовках и описаниях (например, & и '), декодируются
GET/vimeoImport/:channelIdJWT—Импортировать видео из канала Vimeo
GET/:idJWT—Получить проповедь по ID
GET/JWT—Список всех проповедей
POST/JWTStreamingServices.EditСоздать или обновить проповеди. Принимает массив или один объект проповеди (всегда возвращает массив); пустое тело возвращает 400. Поддерживает загрузку миниатюры в формате base64
DELETE/:idJWTStreamingServices.EditУдалить проповедь

Пример: поиск проповеди на YouTube​

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

Плейлисты​

Базовый путь: /content/playlists

Расширяет стандартный CRUD (GET /:id, GET /, DELETE /:id из базового класса; для записи требуется разрешение StreamingServices.Edit).

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить плейлист по ID
GET/JWT—Список всех плейлистов
GET/public/:churchIdПубличный—Список всех публичных плейлистов церкви
POST/JWTStreamingServices.EditСоздать или обновить плейлисты (пакетно, поддерживает загрузку миниатюры в base64)
DELETE/:idJWTStreamingServices.EditУдалить плейлист

Потоковые службы​

Базовый путь: /content/streamingServices

МетодПутьАвторизацияРазрешениеОписание
GET/:id/hostChatJWTChat.HostПолучить зашифрованный ID комнаты чата ведущих для службы
GET/JWT—Список всех потоковых служб. Автоматически удаляет истёкшие разовые службы и переносит повторяющиеся
POST/JWTStreamingServices.EditСоздать или обновить потоковые службы (пакетно)
DELETE/:idJWTStreamingServices.EditУдалить потоковую службу (также очищает заблокированные IP-адреса)

События​

Базовый путь: /content/events

МетодПутьАвторизацияРазрешениеОписание
GET/timeline/group/:groupId?eventIds=JWT—Загрузить события временной шкалы для группы (включает даты исключений, поэтому удалённые вхождения можно пропускать)
GET/timeline?eventIds=JWT—Загрузить события временной шкалы для групп текущего пользователя (включает даты исключений)
GET/subscribe?churchId=&groupId=&curatedCalendarId=Публичный—Подписаться на события как на ICS-ленту календаря
GET/group/:groupIdJWT—Получить события группы (включает даты исключений)
GET/public/group/:churchId/:groupIdПубличный—Получить публичные события группы
GET/public/:churchId/:idПубличный—Получить одно событие для его публичной страницы, с roomNames (комнаты из бронирований, которые не отклонены). Возвращает null для событий в ожидании или отклонённых, а также для закрытых событий, не принимающих регистраций
GET/public/:churchId/:id/icalПубличный—Скачать это отдельное событие как файл .ics (text/calendar, даты исключений учтены). 404, если событие скрыто по тем же правилам
GET/:idJWT—Получить событие по ID
POST/JWT—Создать или обновить события (пакетно)
DELETE/:idJWTContent.Edit, Calendars.Admin или руководитель группыУдалить событие и его бронирования. Руководители группы события могут его удалить, а автор запроса может отозвать собственный запрос в ожидании

Записи событий включают photoUrl (фото события 16:9, которое отображается на публичной странице события и в плитках ближайших событий), tags (через запятую, используются фильтром тегов элемента «Календарь» сайта) и notesViewRole / notesPostRole (staff, если null, leaders или members), которые определяют доступ к беседе eventNote — см. Контроль доступа к заметкам группы и события. Ответы публичных курируемых событий также содержат photoUrl и tags каждого события.

Исключения событий​

Базовый путь: /content/eventExceptions

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить исключение события по ID
POST/JWTContent.Edit, Calendars.Admin или руководитель группыСоздать или обновить исключения событий (пакетно). Руководители могут добавлять исключения только для событий групп, которыми они руководят
DELETE/:idJWTContent.Edit, Calendars.Admin или руководитель группыУдалить исключение события

Курируемые календари​

Базовый путь: /content/curatedCalendars

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить курируемый календарь по ID
GET/JWT—Список всех курируемых календарей
POST/JWTContent.EditСоздать или обновить курируемые календари (пакетно)
DELETE/:idJWTContent.EditУдалить курируемый календарь

Курируемые события​

Базовый путь: /content/curatedEvents

МетодПутьАвторизацияРазрешениеОписание
GET/calendar/:curatedCalendarId?withoutEventsJWT—Получить курируемые события календаря (включает данные о событиях и даты исключений, если не указан ?withoutEvents)
GET/public/calendar/:churchId/:curatedCalendarIdПубличный—Получить публичные курируемые события календаря
GET/:idJWT—Получить курируемое событие по ID
GET/JWT—Список всех курируемых событий
POST/JWTContent.EditСоздать или обновить курируемые события. Массив eventIds позволяет добавлять конкретные события групп
DELETE/:idJWTContent.EditУдалить курируемое событие
DELETE/calendar/:curatedCalendarId/event/:eventIdJWTContent.EditУдалить конкретное событие из курируемого календаря
DELETE/calendar/:curatedCalendarId/group/:groupIdJWTContent.EditУдалить все события группы из курируемого календаря

Файлы​

Базовый путь: /content/files

МетодПутьАвторизацияРазрешениеОписание
GET/:contentType/:contentIdJWT—Получить файлы по типу содержимого и ID содержимого
GET/JWT—Список всех файлов сайта церкви
GET/:idJWT—Получить файл по ID
POST/JWTContent.Edit*Загрузить файлы (base64). *Также разрешено, если пользователь является участником группы, соответствующей contentId
POST/postUrlJWTContent.Edit*Получить предподписанный URL для загрузки в S3. *Также разрешено участникам группы. Максимум 100 МБ на единицу содержимого
DELETE/:idJWTContent.Edit*Удалить файл и убрать его из хранилища. *Также разрешено участникам группы

Галерея​

Базовый путь: /content/gallery

МетодПутьАвторизацияРазрешениеОписание
GET/stock/:folderПубличный—Список стоковых фото в папке
GET/:folderJWTContent.EditСписок изображений галереи в папке
POST/requestUploadJWTContent.EditПолучить предподписанный URL для загрузки S3 для изображения галереи
DELETE/:folder/:imageJWTContent.EditУдалить изображение галереи

Библии​

Базовый путь: /content/bibles

Все эндпоинты Библии публичные (аутентификация не требуется). Данные загружаются из внешних источников и кэшируются локально. Запросы к api.bible прерываются через 15 секунд; при таймауте возвращается 504.

МетодПутьАвторизацияРазрешениеОписание
GET/Публичный—Список всех переводов Библии (загружает из источника, если кэш пуст)
GET/stats?startDate=&endDate=Публичный—Получить статистику поиска по Библии за диапазон дат
GET/availableTranslations/:sourceПубличный—Список доступных переводов из источника (например, api.bible)
GET/updateTranslationsПубличный—Синхронизировать все переводы из всех источников
GET/updateTranslations/:sourceПубличный—Синхронизировать переводы из конкретного источника
GET/updateCopyrightsПубличный—Обновить сведения об авторских правах для переводов, где их нет
GET/:translationKey/updateCopyrightПубличный—Обновить авторские права для конкретного перевода
GET/:translationKey/search?query=&limit=Публичный—Поиск стихов в переводе
GET/:translationKey/booksПубличный—Получить книги перевода (кэширует локально)
GET/:translationKey/:bookKey/chaptersПубличный—Получить главы книги (кэширует локально)
GET/:translationKey/chapters/:chapterKey/versesПубличный—Получить стихи главы (кэширует локально)
GET/:translationKey/verses/:startVerseKey-:endVerseKeyПубличный—Получить текст стихов для диапазона. Записывает поиски в журнал. Некоторые переводы обходят кэш из-за лицензионных условий

Пример: получение текста стихов​

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

Песни​

Базовый путь: /content/songs

МетодПутьАвторизацияРазрешениеОписание
GET/search?q=JWT—Поиск песен по запросу
GET/:idJWT—Получить песню по ID
GET/JWTContent.EditСписок всех песен
POST/JWTContent.EditСоздать или обновить песни (пакетно)
POST/importJWT—Импортировать песни из FreeShow (пакетно)
DELETE/:idJWTContent.EditУдалить песню

Сведения о песнях​

Базовый путь: /content/songDetails

Сведения о песнях глобальные (не привязаны к церкви). Они представляют канонические метаданные песен, общие для всех церквей.

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить сведения о песне по ID (глобально)
GET/JWT—Список сведений о песнях для церкви
POST/createJWT—Создать сведения о песне по ID из PraiseCharts (возвращает существующие, если они уже созданы). Автоматически загружает метаданные из PraiseCharts и MusicBrainz
POST/JWT—Создать или обновить сведения о песнях (пакетно)

Ссылки на сведения о песнях​

Базовый путь: /content/songDetailLinks

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить ссылку на сведения о песне по ID
GET/songDetail/:songDetailIdJWT—Получить все ссылки для сведений о песне
POST/JWT—Создать или обновить ссылки на сведения о песнях (пакетно). Автоматически загружает данные MusicBrainz при связывании
DELETE/:idJWT—Удалить ссылку на сведения о песне

Аранжировки​

Базовый путь: /content/arrangements

МетодПутьАвторизацияРазрешениеОписание
GET/:idJWT—Получить аранжировку по ID
GET/song/:songIdJWTContent.EditПолучить аранжировки для песни
GET/songDetail/:songDetailIdJWTContent.EditПолучить аранжировки для сведений о песне
GET/JWTContent.EditСписок всех аранжировок
POST/JWTContent.EditСоздать или обновить аранжировки (пакетно)
POST/freeShow/missingJWT—Найти ID FreeShow, которых нет в церкви. Тело: { freeShowIds: string[] }
DELETE/:idJWTContent.EditУдалить аранжировку (также удаляет тональности; удаляет песню, если аранжировок не осталось)

Тональности аранжировок​

Базовый путь: /content/arrangementKeys

МетодПутьАвторизацияРазрешениеОписание
GET/presenter/:churchId/:idПубличный—Получить тональность аранжировки с полными данными песни для вида презентации
GET/:idJWT—Получить тональность аранжировки по ID
GET/arrangement/:arrangementIdJWTContent.EditПолучить тональности для аранжировки
GET/JWTContent.EditСписок всех тональностей аранжировок
POST/JWTContent.EditСоздать или обновить тональности аранжировок (пакетно)
DELETE/:idJWTContent.EditУдалить тональность аранжировки

Настройки​

Базовый путь: /content/settings

МетодПутьАвторизацияРазрешениеОписание
GET/myJWT—Получить настройки текущего пользователя
GET/JWTSettings.EditПолучить все настройки церкви
GET/public/:churchIdПубличный—Получить публичные настройки церкви (возвращаются в виде пар «ключ — значение»)
POST/myJWT—Сохранить пользовательские настройки (поддерживает загрузку изображения в base64)
POST/JWTSettings.EditСохранить настройки церкви (поддерживает загрузку изображения в base64)
DELETE/my/:idJWT—Удалить пользовательскую настройку

Предпросмотр​

Базовый путь: /content/preview

МетодПутьАвторизацияРазрешениеОписание
GET/data/:keyПубличный—Загрузить данные предпросмотра потоковой трансляции для церкви по ключу поддомена (вкладки, ссылки, службы, проповеди)

Галерея (стоковые фото)​

Базовый путь: /content/stock

МетодПутьАвторизацияРазрешениеОписание
POST/searchПубличный—Поиск стоковых фото в Pexels. Тело: { term: "church" }

PraiseCharts​

Базовый путь: /content/praiseCharts

Интеграция с PraiseCharts для поиска песен для богослужения и загрузки нотных материалов.

МетодПутьАвторизацияРазрешениеОписание
GET/raw/:idJWT—Получить исходные данные PraiseCharts для песни
GET/hasAccountJWT—Проверить, связан ли у пользователя аккаунт PraiseCharts
GET/search?q=JWT—Поиск в каталоге PraiseCharts
GET/products/:id?keys=JWT—Получить продукты для песни (из библиотеки, если пользователь аутентифицирован, иначе из каталога)
GET/arrangement/raw/:id?keys=JWT—Получить исходные данные аранжировки из библиотеки
GET/download?skus=&keys=&file_name=JWT—Скачать файл из PraiseCharts (PDF или ZIP). Возвращает { redirectUrl }
GET/authUrl?returnUrl=Публичный—Получить URL авторизации OAuth для PraiseCharts
GET/access?verifier=&token=&secret=JWT—Обменять верификатор OAuth на токен доступа и сохранить его в пользовательских настройках
GET/libraryJWT—Просмотр библиотеки пользователя в PraiseCharts

Поддержка​

Базовый путь: /content/support

МетодПутьАвторизацияРазрешениеОписание
POST/createAudioПубличный—Преобразовать SSML в аудио MP3 с помощью AWS Polly. Тело: { ssml: "<speak>...</speak>" }

Связанные страницы​