Эндпоинты контента
Модуль контента управляет страницами сайта, разделами, элементами, блоками, записями блога, перенаправлениями, проповедями, плейлистами, потоковыми службами, событиями, курируемыми календарями, файлами, галереями, переводами Библии и поиском стихов, песнями, аранжировками, глобальными стилями, стоковыми фотографиями и настройками. Это самый крупный модуль 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 | /:id | JWT | — | Получить страницу по ID |
| GET | / | JWT | — | Получить все страницы церкви |
| POST | /duplicate/:id | JWT | Content.Edit | Дублировать страницу со всеми разделами и элементами |
| POST | /temp/ai | JWT | Content.Edit | Сохранить страницу, созданную ИИ (страница, разделы и элементы одним вызовом) |
| POST | /importTree | JWT | Content.Edit | Создать страницу из вложенного дерева (title, url, sections[].elements[]…). Всегда вставляет данные в церковь вызывающего; ID в теле запроса игнорируются. Строки должны включать дочерние column. Максимум 30 разделов / 500 элементов |
| POST | / | JWT | Content.Edit | Создать или обновить страницы (пакетно) |
| DELETE | /:id | JWT | Content.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 | /:id | JWT | — | Получить раздел по ID |
| POST | /duplicate/:id?convertToBlock= | JWT | Content.Edit | Дублировать раздел или преобразовать его в повторно используемый блок |
| POST | / | JWT | Content.Edit | Создать или обновить разделы (пакетно). Порядок сортировки обновляется автоматически |
| DELETE | /:id | JWT | Content.Edit | Удалить раздел (порядок сортировки обновляется автоматически) |
Элементы
Базовый путь: /content/elements
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить элемент по ID |
| POST | /duplicate/:id | JWT | Content.Edit | Дублировать элемент со всеми дочерними объектами |
| POST | / | JWT | Content.Edit | Создать или обновить элементы (пакетно). Автоматически управляет колонками строк и слайдами карусели |
| DELETE | /:id | JWT | Content.Edit | Удалить элемент |
Блоки
Базовый путь: /content/blocks
Расширяет стандартный CRUD (GET /:id, GET /, POST /, DELETE /:id из базового класса; для записи требуется разрешение Content.Edit).
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить блок по ID |
| GET | / | JWT | — | Получить все блоки |
| GET | /:churchId/tree/:id | Публичный | — | Загрузить полное дерево блока с разделами и элементами |
| GET | /blockType/:blockType | JWT | — | Загрузить блоки по типу (например, footerBlock, elementBlock) |
| GET | /public/footer/:churchId | Публичный | — | Загрузить дерево блока подвала для церкви |
| POST | / | JWT | Content.Edit | Создать или обновить блоки |
| DELETE | /:id | JWT | Content.Edit | Удалить блок |
Ссылки
Базовый путь: /content/links
Расширяет стандартный CRUD (GET /:id, GET /, POST /, DELETE /:id из базового класса; для записи требуется разрешение Content.Edit).
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить ссылку по ID |
| GET | / | JWT | — | Список всех ссылок. Необязательный фильтр ?category=. Автоматически сортируется после сохранения |
| GET | /church/:churchId/filtered?category= | JWT | — | Загрузить ссылки, отфильтрованные по видимости (everyone, visitors, members, staff, groups) |
| GET | /church/:churchId?category= | Публичный | — | Загрузить ссылки церкви по категории (публично) |
| POST | / | JWT | Content.Edit | Создать или обновить ссылки (пакетно). Автоматически сортирует по категории |
| DELETE | /:id | JWT | Content.Edit | Удалить ссылку |
Глобальные стили
Базовый путь: /content/globalStyles
Расширяет стандартный CRUD (POST /, DELETE /:id из базового класса; для записи требуется разрешение Content.Edit).
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /church/:churchId | Публичный | — | Загрузить глобальные стили церкви (возвращает значения по умолчанию, если они не заданы) |
| GET | / | JWT | — | Загрузить глобальные стили для аутентифицированной церкви |
| POST | / | JWT | Content.Edit | Создать или обновить глобальные стили |
| DELETE | /:id | JWT | Content.Edit | Удалить глобальные стили |
История страниц
Базовый путь: /content/pageHistory
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /page/:pageId | JWT | Content.Edit | Список записей истории для страницы |
| GET | /block/:blockId | JWT | Content.Edit | Список записей истории для блока |
| GET | /:id | JWT | Content.Edit | Получить запись истории по ID |
| POST | / | JWT | Content.Edit | Сохранить снимок страницы или блока. Периодически удаляет записи старше 30 дней |
| POST | /restore/:id | JWT | Content.Edit | Восстановить страницу или блок из снимка истории (удаляет текущее содержимое и создаёт его заново из снимка) |
| POST | /restoreSnapshot | JWT | Content.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 | /:id | JWT | — | Получить запись по ID |
| GET | / | JWT | — | Список всех записей церкви |
| POST | / | JWT | Content.Edit | Создать или обновить записи (пакетно) |
| DELETE | /:id | JWT | Content.Edit | Удалить запись |
Перенаправления
Базовый путь: /content/redirects
URL-перенаправления для каждой церкви (fromPath → toPath), не более 200 на церковь. Пути нормализуются (приводятся к нижнему регистру, с ведущим слэшем, без завершающего слэша), а fromPath уникален для каждой церкви. B1App обрабатывает их при запросах, которые привели бы к 404, и отвечает HTTP 308.
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /public/:churchId?path= | Публичный | — | Определить перенаправление для пути (или вернуть все перенаправления, если path не указан) |
| GET | /:id | JWT | — | Получить перенаправление по ID |
| GET | / | JWT | — | Список всех перенаправлений церкви |
| POST | / | JWT | Content.Edit | Создать или обновить перенаправления. Отклоняет fromPath = toPath и соблюдает ограничение в 200 записей |
| DELETE | /:id | JWT | Content.Edit | Удалить перенаправление |
Проповеди
Базовый путь: /content/sermons
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /public/freeshowSample | JWT | — | Получить пример структуры плейлиста FreeShow |
| GET | /public/tvWrapper/:churchId | JWT | — | Получить обёртку для ТВ-приложения с источниками проповедей, уроков и 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/:channelId | JWT | — | Импортировать видео из канала YouTube. HTML-сущности, которые API поиска YouTube использует в заголовках и описаниях (например, & и '), декодируются |
| GET | /vimeoImport/:channelId | JWT | — | Импортировать видео из канала Vimeo |
| GET | /:id | JWT | — | Получить проповедь по ID |
| GET | / | JWT | — | Список всех проповедей |
| POST | / | JWT | StreamingServices.Edit | Создать или обновить проповеди. Принимает массив или один объект проповеди (всегда возвращает массив); пустое тело возвращает 400. Поддерживает загрузку миниатюры в формате base64 |
| DELETE | /:id | JWT | StreamingServices.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 | /:id | JWT | — | Получить плейлист по ID |
| GET | / | JWT | — | Список всех плейлистов |
| GET | /public/:churchId | Публичный | — | Список всех публичных плейлистов церкви |
| POST | / | JWT | StreamingServices.Edit | Создать или обновить плейлисты (пакетно, поддерживает загрузку миниатюры в base64) |
| DELETE | /:id | JWT | StreamingServices.Edit | Удалить плейлист |
Потоковые службы
Базовый путь: /content/streamingServices
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id/hostChat | JWT | Chat.Host | Получить зашифрованный ID комнаты чата ведущих для службы |
| GET | / | JWT | — | Список всех потоковых служб. Автоматически удаляет истёкшие разовые службы и переносит повторяющиеся |
| POST | / | JWT | StreamingServices.Edit | Создать или обновить потоковые службы (пакетно) |
| DELETE | /:id | JWT | StreamingServices.Edit | Удалить потоковую службу (также очищает заблокированные IP-адреса) |
События
Базовый путь: /content/events
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /timeline/group/:groupId?eventIds= | JWT | — | Загрузить события временной шкалы для группы (включает даты исключений, поэтому удалённые вхождения можно пропускать) |
| GET | /timeline?eventIds= | JWT | — | Загрузить события временной шкалы для групп текущего пользователя (включает даты исключений) |
| GET | /subscribe?churchId=&groupId=&curatedCalendarId= | Публичный | — | Подписаться на события как на ICS-ленту календаря |
| GET | /group/:groupId | JWT | — | Получить события группы (включает даты исключений) |
| GET | /public/group/:churchId/:groupId | Публичный | — | Получить публичные события группы |
| GET | /public/:churchId/:id | Публичный | — | Получить одно событие для его публичной страницы, с roomNames (комнаты из бронирований, которые не отклонены). Возвращает null для событий в ожидании или отклонённых, а также для закрытых событий, не принимающих регистраций |
| GET | /public/:churchId/:id/ical | Публичный | — | Скачать это отдельное событие как файл .ics (text/calendar, даты исключений учтены). 404, если событие скрыто по тем же правилам |
| GET | /:id | JWT | — | Получить событие по ID |
| POST | / | JWT | — | Создать или обновить события (пакетно) |
| DELETE | /:id | JWT | Content.Edit, Calendars.Admin или руководитель группы | Удалить событие и его бронирования. Руководители группы события могут его удалить, а автор запроса может отозвать собственный запрос в ожидании |
Записи событий включают photoUrl (фото события 16:9, которое отображается на публичной странице события и в плитках ближайших событий), tags (через запятую, используются фильтром тегов элемента «Календарь» сайта) и notesViewRole / notesPostRole (staff, если null, leaders или members), которые определяют доступ к беседе eventNote — см. Контроль доступа к заметкам группы и события. Ответы публичных курируемых событий также содержат photoUrl и tags каждого события.
Исключения событий
Базовый путь: /content/eventExceptions
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить исключение события по ID |
| POST | / | JWT | Content.Edit, Calendars.Admin или руководитель группы | Создать или обновить исключения событий (пакетно). Руководители могут добавлять исключения только для событий групп, которыми они руководят |
| DELETE | /:id | JWT | Content.Edit, Calendars.Admin или руководитель группы | Удалить исключение события |
Курируемые календари
Базовый путь: /content/curatedCalendars
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить курируемый календарь по ID |
| GET | / | JWT | — | Список всех курируемых календарей |
| POST | / | JWT | Content.Edit | Создать или обновить курируемые календари (пакетно) |
| DELETE | /:id | JWT | Content.Edit | Удалить курируемый календарь |
Курируемые события
Базовый путь: /content/curatedEvents
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /calendar/:curatedCalendarId?withoutEvents | JWT | — | Получить курируемые события календаря (включает данные о событиях и даты исключений, если не указан ?withoutEvents) |
| GET | /public/calendar/:churchId/:curatedCalendarId | Публичный | — | Получить публичные курируемые события календаря |
| GET | /:id | JWT | — | Получить курируемое событие по ID |
| GET | / | JWT | — | Список всех курируемых событий |
| POST | / | JWT | Content.Edit | Создать или обновить курируемые события. Массив eventIds позволяет добавлять конкретные события групп |
| DELETE | /:id | JWT | Content.Edit | Удалить курируемое событие |
| DELETE | /calendar/:curatedCalendarId/event/:eventId | JWT | Content.Edit | Удалить конкретное событие из курируемого календаря |
| DELETE | /calendar/:curatedCalendarId/group/:groupId | JWT | Content.Edit | Удалить все события группы из курируемого календаря |
Файлы
Базовый путь: /content/files
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:contentType/:contentId | JWT | — | Получить файлы по типу содержимого и ID содержимого |
| GET | / | JWT | — | Список всех файлов сайта церкви |
| GET | /:id | JWT | — | Получить файл по ID |
| POST | / | JWT | Content.Edit* | Загрузить файлы (base64). *Также разрешено, если пользователь является участником группы, соответствующей contentId |
| POST | /postUrl | JWT | Content.Edit* | Получить предподписанный URL для загрузки в S3. *Также разрешено участникам группы. Максимум 100 МБ на единицу содержимого |
| DELETE | /:id | JWT | Content.Edit* | Удалить файл и убрать его из хранилища. *Также разрешено участникам группы |
Галерея
Базовый путь: /content/gallery
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /stock/:folder | Публичный | — | Список стоковых фото в папке |
| GET | /:folder | JWT | Content.Edit | Список изображений галереи в папке |
| POST | /requestUpload | JWT | Content.Edit | Получить предподписанный URL для загрузки S3 для изображения галереи |
| DELETE | /:folder/:image | JWT | Content.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 | /:id | JWT | — | Получить песню по ID |
| GET | / | JWT | Content.Edit | Список всех песен |
| POST | / | JWT | Content.Edit | Создать или обновить песни (пакетно) |
| POST | /import | JWT | — | Импортировать песни из FreeShow (пакетно) |
| DELETE | /:id | JWT | Content.Edit | Удалить песню |
Сведения о песнях
Базовый путь: /content/songDetails
Сведения о песнях глобальные (не привязаны к церкви). Они представляют канонические метаданные песен, общие для всех церквей.
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить сведения о песне по ID (глобально) |
| GET | / | JWT | — | Список сведений о песнях для церкви |
| POST | /create | JWT | — | Создать сведения о песне по ID из PraiseCharts (возвращает существующие, если они уже созданы). Автоматически загружает метаданные из PraiseCharts и MusicBrainz |
| POST | / | JWT | — | Создать или обновить сведения о песнях (пакетно) |
Ссылки на сведения о песнях
Базовый путь: /content/songDetailLinks
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить ссылку на сведения о песне по ID |
| GET | /songDetail/:songDetailId | JWT | — | Получить все ссылки для сведений о песне |
| POST | / | JWT | — | Создать или обновить ссылки на сведения о песнях (пакетно). Автоматически загружает данные MusicBrainz при связывании |
| DELETE | /:id | JWT | — | Удалить ссылку на сведения о песне |
Аранжировки
Базовый путь: /content/arrangements
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /:id | JWT | — | Получить аранжировку по ID |
| GET | /song/:songId | JWT | Content.Edit | Получить аранжировки для песни |
| GET | /songDetail/:songDetailId | JWT | Content.Edit | Получить аранжировки для сведений о песне |
| GET | / | JWT | Content.Edit | Список всех аранжировок |
| POST | / | JWT | Content.Edit | Создать или обновить аранжировки (пакетно) |
| POST | /freeShow/missing | JWT | — | Найти ID FreeShow, которых нет в церкви. Тело: { freeShowIds: string[] } |
| DELETE | /:id | JWT | Content.Edit | Удалить аранжировку (также удаляет тональности; удаляет песню, если аранжировок не осталось) |
Тональности аранжировок
Базовый путь: /content/arrangementKeys
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /presenter/:churchId/:id | Публичный | — | Получить тональность аранжировки с полными данными песни для вида презентации |
| GET | /:id | JWT | — | Получить тональность аранжировки по ID |
| GET | /arrangement/:arrangementId | JWT | Content.Edit | Получить тональности для аранжировки |
| GET | / | JWT | Content.Edit | Список всех тональностей аранжировок |
| POST | / | JWT | Content.Edit | Создать или обновить тональности аранжировок (пакетно) |
| DELETE | /:id | JWT | Content.Edit | Удалить тональность аранжировки |
Настройки
Базовый путь: /content/settings
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /my | JWT | — | Получить настройки текущего пользователя |
| GET | / | JWT | Settings.Edit | Получить все настройки церкви |
| GET | /public/:churchId | Публичный | — | Получить публичные настройки церкви (возвращаются в виде пар «ключ — значение») |
| POST | /my | JWT | — | Сохранить пользовательские настройки (поддерживает загрузку изображения в base64) |
| POST | / | JWT | Settings.Edit | Сохранить настройки церкви (поддерживает загрузку изображения в base64) |
| DELETE | /my/:id | JWT | — | Удалить пользовательскую настройку |
Предпросмотр
Базовый путь: /content/preview
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /data/:key | Публичный | — | Загрузить данные предпросмотра потоковой трансляции для церкви по ключу поддомена (вкладки, ссылки, службы, проповеди) |
Галерея (стоковые фото)
Базовый путь: /content/stock
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| POST | /search | Публичный | — | Поиск стоковых фото в Pexels. Тело: { term: "church" } |
PraiseCharts
Базовый путь: /content/praiseCharts
Интеграция с PraiseCharts для поиска песен для богослужения и загрузки нотных материалов.
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| GET | /raw/:id | JWT | — | Получить исходные данные PraiseCharts для песни |
| GET | /hasAccount | JWT | — | Проверить, связан ли у пользователя аккаунт 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 | /library | JWT | — | Просмотр библиотеки пользователя в PraiseCharts |
Поддержка
Базовый путь: /content/support
| Метод | Путь | Авторизация | Разрешение | Описание |
|---|---|---|---|---|
| POST | /createAudio | Публичный | — | Преобразовать SSML в аудио MP3 с помощью AWS Polly. Тело: { ssml: "<speak>...</speak>" } |
Связанные страницы
- Архитектура конструктора сайтов -- Как страницы, разделы, элементы, записи и перенаправления связаны между приложениями
- Эндпоинты членства -- Люди, церкви, группы, роли, разрешения
- Эндпоинты посещаемости -- Учёт служений и визитов
- Аутентификация и разрешения -- Процесс входа, JWT, модель разрешений
- Структура модуля -- Организация кода