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

Эндпоинты Membership

Модуль Membership управляет людьми, церквями, группами, домохозяйствами, ролями, правами доступа, формами и настройками. Это самый крупный модуль; он обеспечивает основной слой идентификации и авторизации для всех остальных модулей.

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

Люди​

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

МетодПутьAuthПраваОписание
GET/JWTPeople.View или MemberСписок всех людей церкви
GET/:idJWTPeople.View или собственная записьПолучить человека по ID (включает отправки форм)
GET/ids?ids=JWTPeople.View, Member или People.ViewNamesПолучить нескольких людей по ID, перечисленным через запятую. Вызывающие с People.ViewNames без People.View получают базовую модель, при этом люди, отказавшиеся от показа, не возвращаются (кроме самого вызывающего)
GET/basic?ids=JWT—Получить базовые сведения (только имя) для нескольких людей
GET/names?ids=JWTЛюбое право церкви[{ id, name: { display, first, last }, photo }], отсортировано по фамилии, затем по имени, для перечисленных через запятую ID, которые вызывающий уже видит, чтобы роли без People.View (пожертвования, посещаемость) могли подписывать людей. Поиска и фильтра каталога нет
POST/namesJWTЛюбое право церквиТо же, что GET /names. Тело: { peopleIds } (или { ids })
GET/recentJWTPeople.View, Member или People.ViewNamesНедавно добавленные люди. Вызывающие с People.ViewNames без People.View (даже участники с доступом к каталогу) получают базовую модель (id, name.display, photo, membershipStatus), при этом люди, отказавшиеся от показа, не возвращаются
GET/guest-register/options?churchId=Public—Чек-лист регистрации гостей по QR-коду: возвращает { email, phone, address, birthDate, gender, maritalStatus, grade, comments }, где каждое значение — "off", "optional" или "required" (разбирается из публичной настройки guestRegistrationFields; при отсутствии или неверном значении используются значения по умолчанию: email/телефон — необязательные, остальное — выключено). Требует enableQRGuestRegistration, если только запрос не содержит подходящий токен сайта или церкви; ограничено по частоте (429)
GET/search?term=&email=JWTPeople.View, Member или People.ViewNamesПоиск людей по имени или email (до 100, сортировка по фамилии, затем по имени). Вызывающие с People.ViewNames без People.View (даже участники с доступом к каталогу) получают при поиске по имени базовую модель; поиск по email возвращает []
GET/search/phone?number=JWTPeople.View или MemberПоиск по номеру телефона
GET/search/group?groupId=JWTPeople.View или MemberПолучить людей в конкретной группе
GET/household/:householdIdJWT—Получить всех людей домохозяйства
GET/attendanceJWTPeople.EditЗагрузить посетителей с фильтрами (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWT—Загрузить данные временной шкалы для людей и групп
GET/directory/:idJWT—Получить человека для просмотра в каталоге (учитываются настройки видимости)
GET/claim/:churchIdJWT—Привязать запись человека к текущему пользователю в церкви
POST/JWTPeople.Edit или EditSelfСоздать или обновить людей (пакетно)
POST/searchJWTPeople.View, Member или People.ViewNamesПоиск людей (вариант POST). Тело: { term } или { email }; те же правила для режима только имён, что и у GET /search
POST/advancedSearchJWTPeople.View или MemberПоиск по нескольким условиям (возраст, birthMonth, membershipStatus и др.). Тело — массив условий; пустое тело означает отсутствие условий, а любое другое тело, не являющееся массивом, возвращает 400
POST/loadOrCreatePublic—Найти или создать человека по email. Тело: { churchId, email, firstName, lastName }
POST/guest-registerPublic—Регистрация гостя по QR-коду. Тело: { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (от 1 до 10 участников; email/phone/maritalStatus относятся только к первому участнику). Поля, отключённые церковью, отбрасываются; отсутствующие обязательные или неверные значения возвращают 400. Сначала используются существующие люди: участник совпадает, если ровно один не удалённый человек имеет то же имя (без учёта регистра) и тот же email или цифры телефона (домашний, рабочий или мобильный); участник без email или телефона совпадает по имени внутри совпавшего домохозяйства. Совпавших людей никогда не редактируют. Несовпавшие участники присоединяются к совпавшему домохозяйству или создают новое (названное по фамилии первого участника) со статусом membershipStatus: "Visitor" и общим address. Сохраняет comments как заметку у первого участника, добавляет всех в приватную группу guestRegistrationGroupId, если она задана, и — когда guestRegistrationRecordAttendance равно "true" — записывает посещаемость на те запланированные времена служений этой группы, окно регистрации которых открыто сейчас. Возвращает { householdId, people: [{ id, name }] }, повторяя переданные имена, а не сохранённые. Те же правила согласия/токена и ограничения по частоте, что и для запроса options
POST/household/:householdIdJWTPeople.EditОбновить назначения участников домохозяйства
POST/public/emailPublic—Отправить письмо человеку. Тело: { churchId, personId, subject, body, appName }
POST/apiEmailsInternal—Загрузить email людей по ID (межсерверный вызов, требуется jwtSecret)
DELETE/:idJWTPeople.EditУдалить человека

Пример: поиск людей​

GET /membership/people/search?term=John
Authorization: Bearer <token>
[
{
"id": "abc-123",
"name": { "first": "John", "last": "Smith" },
"contactInfo": { "email": "john@example.com" },
"membershipStatus": "Member"
}
]

Пример: создание человека​

POST /membership/people
Authorization: Bearer <token>

[{ "firstName": "Jane", "lastName": "Doe", "contactInfo": { "email": "jane@example.com" } }]

Пользователи​

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

См. Аутентификация и права доступа — эндпоинты входа, регистрации и управления паролями.

МетодПутьAuthПраваОписание
POST/loginPublic—Вход (email/пароль, обновление JWT или authGuid)
POST/registerPublic—Зарегистрировать нового пользователя
POST/forgotPublic—Отправить письмо для сброса пароля
POST/setPasswordGuidPublic—Задать пароль по auth GUID из ссылки в письме
POST/verifyCredentialsPublic—Проверить email/пароль и вернуть связанные церкви
POST/loadOrCreateJWT—Найти или создать пользователя по email/userId
POST/setDisplayNameJWT—Обновить имя и фамилию пользователя
POST/updateEmailJWT—Сменить email пользователя
POST/updatePasswordJWT—Сменить пароль пользователя (минимум 6 символов)
POST/updateOptedOutJWT—Задать статус отказа от показа для человека
POST/sendInviteEmailJWTPeople.EditОтправить приглашение человеку в этой церкви (email, personName, contextName). Кнопка называется Sign Up для человека без учётной записи и Log In для существующего пользователя. Пользователь, который ни разу не входил, получает ссылку Set Your Password, действительную 7 дней. Это фиксированный шаблон, поэтому он не учитывается в дневном лимите писем церкви
GET/search?term=JWTServer.AdminПоиск всех пользователей по имени/email
DELETE/JWT—Удалить учётную запись текущего пользователя

Церкви​

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

МетодПутьAuthПраваОписание
GET/JWT—Загрузить все церкви текущего пользователя
GET/:idJWT—Получить церковь по ID
GET/:id/getDomainAdminJWT—Получить доменного администратора церкви
GET/:id/impersonateJWTServer.AdminВойти от имени церкви (только администратор сервера)
GET/all?term=JWTServer.AdminПоиск всех церквей (администратор)
GET/search/?name=Public—Поиск церквей по названию
GET/lookup/?subDomain=&id=Public—Найти церковь по поддомену или ID
POST/JWTSettings.EditОбновить данные церкви
POST/addJWT—Зарегистрировать новую церковь. Обязательные поля: name, address1, city, state, zip, country
POST/searchPublic—Поиск церквей по названию (вариант POST)
POST/selectJWT—Выбрать/переключиться на церковь. Тело: { churchId } или { subDomain }
POST/:id/archiveJWTServer.AdminАрхивировать или разархивировать церковь
POST/byIdsPublic—Загрузить несколько церквей по ID
DELETE/deleteAbandonedJWTServer.AdminУдалить церкви, брошенные 7 и более дней

Группы​

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

Наследует стандартный CRUD (GET /, GET /:id из базового класса).

МетодПутьAuthПраваОписание
GET/JWT—Список всех групп
GET/:idJWT—Получить группу по ID
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Поиск групп по фильтрам служений
GET/myJWT—Получить группы текущего пользователя
GET/my/:tagJWT—Получить группы текущего пользователя, отфильтрованные по тегу
GET/tag/:tagJWT—Получить все группы с определённым тегом
GET/public/:churchId/:idPublic—Получить публичную группу по церкви и ID
GET/public/:churchId/tag/:tagPublic—Получить публичные группы по тегу
GET/public/:churchId/label?label=Public—Получить публичные группы по метке
GET/public/:churchId/slug/:slugPublic—Получить публичную группу по slug
POST/JWTGroups.EditСоздать или обновить группы (slug генерируется автоматически)
DELETE/:idJWTGroups.EditУдалить группу (для групп служений также удаляются дочерние команды)

Участники групп​

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

Наследует стандартный CRUD (GET /:id, DELETE /:id из базового класса).

МетодПутьAuthПраваОписание
GET/:idJWTGroupMembers.ViewПолучить участника группы по ID
GET/JWTGroupMembers.View*Список участников групп. Фильтры: ?groupId=, ?groupIds= или ?personId=. *Также разрешено, если пользователь состоит в группе или запрашивает собственный personId, а также для ?groupId= любой не конфиденциальной группы, если у пользователя есть Attendance.View или Attendance.Edit (для них включаются участники младше 13 лет)
GET/myJWT—Получить членство в группах текущего пользователя
GET/basic/:groupIdJWT—Получить базовый список участников группы
GET/public/leaders/:churchId/:groupIdPublic—Получить руководителей группы (публично)
GET/public/:churchId/:groupIdPublic—Получить публичный состав группы (минимальные поля: personId, displayName, leader, фото). Только если группа включила publicRoster; обслуживает элемент staffGrid конструктора сайтов
POST/JWTGroupMembers.EditДобавить или обновить участников групп
DELETE/:idJWTGroupMembers.ViewУдалить участника группы

Домохозяйства​

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

Стандартный контроллер CRUD.

МетодПутьAuthПраваОписание
GET/JWT—Список всех домохозяйств
GET/:idJWT—Получить домохозяйство по ID
POST/JWTPeople.EditСоздать или обновить домохозяйства
DELETE/:idJWTPeople.EditУдалить домохозяйство

Роли​

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

МетодПутьAuthПраваОписание
GET/:idJWTRoles.ViewПолучить роль по ID
GET/church/:churchIdJWTRoles.ViewПолучить все роли церкви. Каждая роль включает memberCount — количество разных пользователей в ней
POST/JWTRoles.EditСоздать или обновить роли
DELETE/:idJWTRoles.EditУдалить роль (также удаляются её права и участники)

Участники ролей​

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

МетодПутьAuthПраваОписание
GET/roles/:idJWTRoles.ViewПолучить участников роли. Добавьте ?include=users, чтобы включить данные пользователей
POST/JWTRoles.EditДобавить участников в роль (создаёт пользователя, если email не существует)
DELETE/:idJWTRoles.ViewУдалить участника роли
DELETE/self/:churchId/:userIdJWT—Удалить себя из церкви

Права ролей​

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

МетодПутьAuthПраваОписание
GET/roles/:idJWTRoles.ViewПолучить права роли (используйте null как ID для роли «Everyone»)
POST/JWTRoles.EditСоздать или обновить права ролей
DELETE/:idJWTRoles.EditУдалить право роли

Права​

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

МетодПутьAuthПраваОписание
GET/JWT—Получить полный список доступных прав

Каждая запись содержит apiName, section (тип содержимого), action и подписи displaySection / displayAction, которые показывает редактор ролей B1Admin. Недавние добавления: MembershipApi / People / View Names (View People Names Only, в разделе People and Groups) и GivingApi / Donations / Enter (Enter Donations, в разделе Donations; см. Пакеты пожертвований).

Формы​

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

МетодПутьAuthПраваОписание
GET/JWTForms.Admin или Forms.EditСписок всех форм (администратор видит все; редакторы — назначенные и не-участнические формы)
GET/:idJWTДоступ к формеПолучить форму по ID
GET/archivedJWTForms.Admin или Forms.EditСписок архивных форм
GET/group/:groupIdJWTУчастник группы, руководитель группы или Forms.AdminОтдельные формы, связанные с группой (forms.groupId), без архивных, отсортированные по названию. Возвращает id, name, description и open (в пределах периода доступности). Участники получают только открытые формы; руководители и администраторы форм также получают закрытые. Обслуживает раздел связанных форм на странице группы
GET/standalone/:id?churchId=JWT—Получить отдельную форму (ограниченные формы требуют аутентификации)
POST/JWTForms.Admin или Forms.EditСоздать или обновить формы. Отдельные формы принимают необязательные photoUrl (фото в шапке над формой) и groupId (связанная группа)
DELETE/:idJWTДоступ к формеУдалить форму

Отправки форм​

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

МетодПутьAuthПраваОписание
GET/JWTForms.Admin или Forms.EditСписок отправок. Фильтры: ?personId= или ?formId=
GET/my?include=questions,answersJWT—Только свои: до 50 отправок отдельных форм (не форм людей), которые отправил вошедший участник или которые привязаны к его записи (contentType = person, contentId = ID его записи — например, после смены человека администратором), сначала новые, каждая с form.name. include добавляет к каждой форме вопросы, а к отправке — ответы. Возвращает 401, если пользователь не привязан к записи человека. Обслуживает раздел My Forms на странице B1 Me
GET/group/:groupIdJWTРуководитель группыОтветы для руководителей группы: по одной записи на каждую связанную форму и на каждое событие группы с формой регистрации; каждая содержит form, event (id, title, start; только для записей о событиях), questions и submissions (с answers и personName, null для анонимных)
GET/:idJWTForms.Admin, Forms.Edit или право на просмотрПолучить отправку по ID. Добавьте ?include=form,questions,answers. Руководители связанной с формой группы, а также руководители группы, к которой относится регистрация на событие, также могут её читать
GET/formId/:formIdJWTДоступ к форме (просмотр)Получить все отправки формы (включает форму, вопросы, ответы). Руководители связанной с формой группы имеют доступ на просмотр
POST/JWT—Отправить ответы на форму (обрабатывает ограниченные и неограниченные формы, отправляет уведомления по email). Если у формы включён autoCreatePerson, находит или создаёт Guest-человека по email и привязывает к нему отправку; если у формы также есть groupId, добавляет этого человека в группу; если заданы followUpSubject/followUpBody, отправляет отправителю письмо по шаблону. Если вызывающий не может управлять формой, submittedBy всегда устанавливается в запись человека вошедшего участника (или остаётся пустым для анонимных отправок)
DELETE/:idJWTForms.Admin или Forms.EditУдалить отправку и её ответы

Вопросы​

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

МетодПутьAuthПраваОписание
GET/JWTДоступ к формеСписок вопросов формы. Требуется ?formId=
GET/:idJWTДоступ к формеПолучить вопрос по ID
GET/unrestricted?formId=JWT—Получить вопросы неограниченной формы
GET/sort/:id/upJWT—Переместить вопрос вверх в порядке сортировки
GET/sort/:id/downJWT—Переместить вопрос вниз в порядке сортировки
POST/JWTДоступ к формеСоздать или обновить вопросы (порядок сортировки назначается автоматически)
DELETE/:id?formId=JWTДоступ к формеУдалить вопрос

Ответы​

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

МетодПутьAuthПраваОписание
GET/JWTForms.Admin или Forms.EditСписок ответов. Фильтр: ?formSubmissionId=
POST/JWTForms.Admin или Forms.EditСоздать или обновить ответы

Права участников на формы​

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

Управляет доступом отдельных участников к конкретным формам.

МетодПутьAuthПраваОписание
GET/:idJWTДоступ к формеПолучить право участника на форму по ID
GET/member/:idJWTДоступ к формеПолучить все права участника на формы
GET/form/:idJWTДоступ к формеПолучить все права участников на форму
GET/form/:id/myJWTДоступ к формеПолучить право текущего пользователя на форму
POST/JWTДоступ к формеСоздать или обновить права участника на форму
DELETE/:id?formId=JWTДоступ к формеУдалить право участника на форму
DELETE/member/:id?formId=JWTДоступ к формеУдалить все права участника на форме

Настройки​

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

МетодПутьAuthПраваОписание
GET/JWTSettings.EditПолучить все настройки церкви
GET/public/:churchIdPublic—Получить публичные настройки церкви
POST/JWTSettings.EditСохранить настройки (поддерживает загрузку изображений в base64)

Домены​

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

Наследует стандартный CRUD (GET /:id, GET /, DELETE /:id из базового класса).

МетодПутьAuthПраваОписание
GET/JWT—Список всех доменов
GET/:idJWT—Получить домен по ID
GET/lookup/:domainNameJWT—Найти домен по имени
GET/public/lookup/:domainNamePublic—Публичный поиск домена по имени
GET/health/checkPublic—Запустить проверку работоспособности непроверенных доменов
POST/JWTSettings.EditСоздать или обновить домены (обновляет Caddy)
DELETE/:idJWTSettings.EditУдалить домен

Связь пользователя с церковью​

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

Управляет связью между пользователями и церквями.

МетодПутьAuthПраваОписание
GET/userid/:userIdJWT—Получить запись «пользователь — церковь» по ID пользователя
GET/personid/:personIdJWT—Получить email связанного пользователя для человека
GET/user/:userIdJWTServer.AdminЗагрузить все церкви пользователя
POST/JWT—Создать связь пользователя с церковью
PATCH/:userIdJWT—Обновить время последнего доступа и записать доступ в журнал
DELETE/record/:userId/:churchId/:personIdJWT—Удалить запись «пользователь — церковь»

Настройки видимости​

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

МетодПутьAuthПраваОписание
GET/myJWT—Получить настройки видимости текущего пользователя
POST/JWT—Сохранить настройки видимости (видимость адреса, телефона, email)

Запрос​

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

МетодПутьAuthПраваОписание
POST/membersJWT—Поиск участников на естественном языке с помощью ИИ. Тело: { text, subDomain, siteUrl }

Ошибки клиента​

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

МетодПутьAuthПраваОписание
POST/JWT—Записать ошибку на стороне клиента

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