Saltar al contenido principal

Endpoints de Membership

El módulo Membership administra personas, iglesias, grupos, hogares, roles, permisos, formularios y configuración. Es el módulo más grande y proporciona la capa central de identidad y autorización para todos los demás módulos.

Ruta base: /membership

Personas​

Ruta base: /membership/people

MétodoRutaAutenticaciónPermisoDescripción
GET/JWTPeople.View o MemberEnumera todas las personas de la iglesia
GET/:idJWTPeople.View o su propio registroObtiene una persona por ID (incluye los envíos de formularios)
GET/ids?ids=JWTPeople.View, Member o People.ViewNamesObtiene varias personas por IDs separados por comas. Quienes llaman con People.ViewNames sin People.View reciben el modelo básico, y se omiten las personas que se dieron de baja (salvo quien llama)
GET/basic?ids=JWT—Obtiene información básica (solo el nombre) de varias personas
GET/names?ids=JWTCualquier permiso de la iglesia[{ id, name: { display, first, last }, photo }], ordenado por apellido y luego por nombre, para los IDs separados por comas que quien llama ya tiene, de modo que los roles sin People.View (donaciones, asistencia) puedan identificar a las personas. Sin búsqueda ni filtro de directorio
POST/namesJWTCualquier permiso de la iglesiaIgual que GET /names. Cuerpo: { peopleIds } (o { ids })
GET/recentJWTPeople.View, Member o People.ViewNamesPersonas agregadas recientemente. Quienes llaman con People.ViewNames sin People.View (incluso los miembros con acceso al directorio) reciben el modelo básico (id, name.display, photo, membershipStatus), y se omiten las personas que se dieron de baja
GET/guest-register/options?churchId=Pública—Lista de verificación del registro de invitados por QR: devuelve { email, phone, address, birthDate, gender, maritalStatus, grade, comments }, cada uno con "off", "optional" o "required" (se interpreta a partir de la configuración pública guestRegistrationFields; los valores faltantes o mal formados recurren a correo y teléfono como opcionales, y el resto desactivado). Requiere enableQRGuestRegistration, salvo que la solicitud incluya un token de sitio/iglesia coincidente; tiene límite de tasa (429)
GET/search?term=&email=JWTPeople.View, Member o People.ViewNamesBusca personas por nombre o correo electrónico (hasta 100, ordenadas por apellido y luego por nombre). Quienes llaman con People.ViewNames sin People.View (incluso los miembros con acceso al directorio) obtienen una búsqueda por nombre que devuelve el modelo básico; una búsqueda por email devuelve []
GET/search/phone?number=JWTPeople.View o MemberBusca por número de teléfono
GET/search/group?groupId=JWTPeople.View o MemberObtiene las personas de un grupo específico
GET/household/:householdIdJWT—Obtiene todas las personas de un hogar
GET/attendanceJWTPeople.EditCarga asistentes con filtros (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWT—Carga datos de línea de tiempo para personas y grupos
GET/directory/:idJWT—Obtiene una persona para la vista del directorio (respeta las preferencias de visibilidad)
GET/claim/:churchIdJWT—Reclama un registro de persona para el usuario actual en una iglesia
POST/JWTPeople.Edit o EditSelfCrea o actualiza personas (por lote)
POST/searchJWTPeople.View, Member o People.ViewNamesBusca personas (variante POST). Cuerpo: { term } o { email }; mismas reglas de solo nombres que GET /search
POST/advancedSearchJWTPeople.View o MemberBúsqueda de múltiples condiciones (edad, birthMonth, membershipStatus, etc.). El cuerpo es un arreglo de condiciones; un cuerpo vacío significa sin condiciones, y cualquier otro cuerpo que no sea un arreglo devuelve 400
POST/loadOrCreatePública—Busca o crea una persona por correo electrónico. Cuerpo: { churchId, email, firstName, lastName }
POST/guest-registerPública—Registro de invitados por QR. Cuerpo: { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (de 1 a 10 miembros; email/phone/maritalStatus aplican solo al primer miembro). Los campos que la iglesia desactivó se descartan; los valores obligatorios faltantes o inválidos devuelven 400. Primero reutiliza personas existentes: un miembro coincide cuando exactamente una persona no eliminada tiene el mismo nombre (sin distinguir mayúsculas) y el mismo correo electrónico o los mismos dígitos de teléfono (casa, trabajo o celular); un miembro sin correo ni teléfono coincide por nombre dentro del hogar relacionado. Las personas relacionadas nunca se editan. Los miembros no relacionados se unen al hogar relacionado, o bien a un hogar nuevo (con el apellido del primer miembro), como membershipStatus: "Visitor" con la address compartida. Guarda comments como una nota en el primer miembro, agrega a todos al grupo privado guestRegistrationGroupId si está configurado, y, cuando guestRegistrationRecordAttendance es "true", registra la asistencia en los horarios de servicio programados de ese grupo cuya ventana de registro esté abierta en este momento. Devuelve { householdId, people: [{ id, name }] }, repitiendo los nombres enviados en lugar de los guardados. Las mismas reglas de consentimiento/token y de límite de tasa que la llamada de opciones
POST/household/:householdIdJWTPeople.EditActualiza las asignaciones de miembros de un hogar
POST/public/emailPública—Envía un correo electrónico a una persona. Cuerpo: { churchId, personId, subject, body, appName }
POST/apiEmailsInterna—Carga los correos de personas por IDs (de servidor a servidor, requiere jwtSecret)
DELETE/:idJWTPeople.EditElimina una persona

Ejemplo: buscar personas​

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

Ejemplo: crear una persona​

POST /membership/people
Authorization: Bearer <token>

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

Usuarios​

Ruta base: /membership/users

Consulte Autenticación y permisos para los endpoints de inicio de sesión, registro y administración de contraseñas.

MétodoRutaAutenticaciónPermisoDescripción
POST/loginPública—Inicia sesión (correo/contraseña, renovación de JWT o authGuid)
POST/registerPública—Registra un nuevo usuario
POST/forgotPública—Envía un correo de restablecimiento de contraseña
POST/setPasswordGuidPública—Establece la contraseña con el GUID de autenticación del enlace del correo
POST/verifyCredentialsPública—Verifica correo y contraseña y devuelve las iglesias asociadas
POST/loadOrCreateJWT—Busca o crea un usuario por correo o userId
POST/setDisplayNameJWT—Actualiza el nombre y el apellido del usuario
POST/updateEmailJWT—Cambia la dirección de correo electrónico del usuario
POST/updatePasswordJWT—Cambia la contraseña del usuario (mínimo 6 caracteres)
POST/updateOptedOutJWT—Establece el estado de baja de una persona
POST/sendInviteEmailJWTPeople.EditEnvía por correo una invitación a una persona de esta iglesia (email, personName, contextName). El botón dice Sign Up para alguien sin cuenta y Log In para un usuario existente. Un usuario que nunca ha iniciado sesión recibe en cambio un enlace Set Your Password que caduca en 7 días. Es una plantilla fija, así que no cuenta para el límite diario de correos de la iglesia
GET/search?term=JWTServer.AdminBusca todos los usuarios por nombre o correo electrónico
DELETE/JWT—Elimina la cuenta del usuario actual

Iglesias​

Ruta base: /membership/churches

MétodoRutaAutenticaciónPermisoDescripción
GET/JWT—Carga todas las iglesias del usuario actual
GET/:idJWT—Obtiene una iglesia por ID
GET/:id/getDomainAdminJWT—Obtiene el usuario administrador de dominio de una iglesia
GET/:id/impersonateJWTServer.AdminSuplanta una iglesia (solo administrador del servidor)
GET/all?term=JWTServer.AdminBusca todas las iglesias (administración)
GET/search/?name=Pública—Busca iglesias por nombre
GET/lookup/?subDomain=&id=Pública—Busca una iglesia por subdominio o ID
POST/JWTSettings.EditActualiza los datos de la iglesia
POST/addJWT—Registra una nueva iglesia. Campos obligatorios: name, address1, city, state, zip, country
POST/searchPública—Busca iglesias por nombre (variante POST)
POST/selectJWT—Selecciona o cambia a una iglesia. Cuerpo: { churchId } o { subDomain }
POST/:id/archiveJWTServer.AdminArchiva o desarchiva una iglesia
POST/byIdsPública—Carga varias iglesias por IDs
DELETE/deleteAbandonedJWTServer.AdminElimina las iglesias abandonadas durante 7 o más días

Grupos​

Ruta base: /membership/groups

Extiende el CRUD estándar (GET /, GET /:id de la clase base).

MétodoRutaAutenticaciónPermisoDescripción
GET/JWT—Enumera todos los grupos
GET/:idJWT—Obtiene un grupo por ID
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Busca grupos por filtros de servicio
GET/myJWT—Obtiene los grupos del usuario actual
GET/my/:tagJWT—Obtiene los grupos del usuario actual filtrados por etiqueta
GET/tag/:tagJWT—Obtiene todos los grupos con una etiqueta específica
GET/public/:churchId/:idPública—Obtiene un grupo público por iglesia e ID
GET/public/:churchId/tag/:tagPública—Obtiene grupos públicos por etiqueta
GET/public/:churchId/label?label=Pública—Obtiene grupos públicos por etiqueta de categoría
GET/public/:churchId/slug/:slugPública—Obtiene un grupo público por slug
POST/JWTGroups.EditCrea o actualiza grupos (genera el slug automáticamente)
DELETE/:idJWTGroups.EditElimina un grupo (también elimina los equipos hijos de los grupos de ministerio)

Miembros de grupo​

Ruta base: /membership/groupmembers

Extiende el CRUD estándar (GET /:id, DELETE /:id de la clase base).

MétodoRutaAutenticaciónPermisoDescripción
GET/:idJWTGroupMembers.ViewObtiene un miembro de grupo por ID
GET/JWTGroupMembers.View*Enumera los miembros de grupo. Filtre con ?groupId=, ?groupIds= o ?personId=. *También se permite si el usuario está en el grupo o consulta su propio personId, y para ?groupId= de cualquier grupo no confidencial cuando el usuario tiene Attendance.View o Attendance.Edit (se incluyen los miembros menores de 13 años para ellos)
GET/myJWT—Obtiene las membresías de grupo del usuario actual
GET/basic/:groupIdJWT—Obtiene la lista básica de miembros de un grupo
GET/public/leaders/:churchId/:groupIdPública—Obtiene los líderes de un grupo (público)
GET/public/:churchId/:groupIdPública—Obtiene la lista pública de un grupo (campos mínimos: personId, displayName, leader, foto). Solo cuando el grupo se incluye mediante publicRoster; alimenta el elemento staffGrid del creador de sitios web
POST/JWTGroupMembers.EditAgrega o actualiza miembros de grupo
DELETE/:idJWTGroupMembers.ViewQuita un miembro de grupo

Hogares​

Ruta base: /membership/households

Controlador CRUD estándar.

MétodoRutaAutenticaciónPermisoDescripción
GET/JWT—Enumera todos los hogares
GET/:idJWT—Obtiene un hogar por ID
POST/JWTPeople.EditCrea o actualiza hogares
DELETE/:idJWTPeople.EditElimina un hogar

Roles​

Ruta base: /membership/roles

MétodoRutaAutenticaciónPermisoDescripción
GET/:idJWTRoles.ViewObtiene un rol por ID
GET/church/:churchIdJWTRoles.ViewObtiene todos los roles de una iglesia. Cada rol incluye memberCount, el número de usuarios distintos que contiene
POST/JWTRoles.EditCrea o actualiza roles
DELETE/:idJWTRoles.EditElimina un rol (también elimina sus permisos y miembros)

Miembros de roles​

Ruta base: /membership/rolemembers

MétodoRutaAutenticaciónPermisoDescripción
GET/roles/:idJWTRoles.ViewObtiene los miembros de un rol. Agregue ?include=users para incluir los detalles de usuario
POST/JWTRoles.EditAgrega miembros a un rol (crea el usuario si el correo no existe)
DELETE/:idJWTRoles.ViewQuita un miembro de un rol
DELETE/self/:churchId/:userIdJWT—Quítese a sí mismo de una iglesia

Permisos de roles​

Ruta base: /membership/rolepermissions

MétodoRutaAutenticaciónPermisoDescripción
GET/roles/:idJWTRoles.ViewObtiene los permisos de un rol (use null como ID para el rol "Everyone")
POST/JWTRoles.EditCrea o actualiza permisos de roles
DELETE/:idJWTRoles.EditElimina un permiso de rol

Permisos​

Ruta base: /membership/permissions

MétodoRutaAutenticaciónPermisoDescripción
GET/JWT—Obtiene la lista completa de permisos disponibles

Cada entrada tiene apiName, section (tipo de contenido), action y las etiquetas displaySection / displayAction que muestra el editor de roles de B1Admin. Adiciones recientes: MembershipApi / People / View Names (View People Names Only, en Personas y grupos) y GivingApi / Donations / Enter (Enter Donations, en Donaciones; consulte Lotes de donaciones).

Formularios​

Ruta base: /membership/forms

MétodoRutaAutenticaciónPermisoDescripción
GET/JWTForms.Admin o Forms.EditEnumera todos los formularios (el administrador ve todos; los editores ven los asignados y los formularios que no son de personas)
GET/:idJWTAcceso al formularioObtiene un formulario por ID
GET/archivedJWTForms.Admin o Forms.EditEnumera los formularios archivados
GET/group/:groupIdJWTMiembro del grupo, líder del grupo o Forms.AdminFormularios independientes vinculados al grupo (forms.groupId), sin los archivados, ordenados por nombre. Devuelve id, name, description y open (dentro de la ventana de disponibilidad). Los miembros solo obtienen los formularios abiertos; los líderes y los administradores de formularios también obtienen los cerrados. Alimenta los formularios vinculados de la página del grupo
GET/standalone/:id?churchId=JWT—Obtiene un formulario independiente (los formularios restringidos requieren autenticación)
POST/JWTForms.Admin o Forms.EditCrea o actualiza formularios. Los formularios independientes aceptan un photoUrl opcional (foto de encabezado que se muestra encima del formulario) y un groupId (grupo vinculado)
DELETE/:idJWTAcceso al formularioElimina un formulario

Envíos de formularios​

Ruta base: /membership/formsubmissions

MétodoRutaAutenticaciónPermisoDescripción
GET/JWTForms.Admin o Forms.EditEnumera los envíos. Filtre con ?personId= o ?formId=
GET/my?include=questions,answersJWT—Limitado al propio usuario: hasta 50 envíos de formularios independientes (no de formularios de personas) que el miembro con sesión iniciada envió o que están vinculados a su persona (contentType person, contentId = su id de persona; por ejemplo, después de un cambio de persona hecho por un administrador), del más reciente al más antiguo, cada uno con form.name. include adjunta las preguntas de cada formulario y las respuestas del envío. Devuelve 401 si el usuario no está vinculado a una persona. Alimenta la sección My Forms de la página Me de B1
GET/group/:groupIdJWTLíder del grupoRespuestas para los líderes del grupo: una entrada por cada formulario vinculado y por cada evento del grupo con un formulario de inscripción, cada una con form, event (id, title, start; solo en las entradas de eventos), questions y submissions (con answers y personName, null si es anónimo)
GET/:idJWTForms.Admin, Forms.Edit o acceso de vistaObtiene un envío por ID. Agregue ?include=form,questions,answers. Los líderes del grupo vinculado al formulario, y los líderes del grupo al que pertenece una inscripción a un evento, también pueden leerlo
GET/formId/:formIdJWTAcceso al formulario (vista)Obtiene todos los envíos de un formulario (incluye form, questions, answers). Los líderes del grupo vinculado al formulario tienen acceso de vista
POST/JWT—Envía las respuestas del formulario (maneja formularios restringidos y no restringidos, y envía notificaciones por correo). Cuando el formulario tiene autoCreatePerson, busca o crea una persona Invitado por correo electrónico y vincula el envío; cuando el formulario también tiene groupId, agrega a esa persona al grupo; cuando followUpSubject/followUpBody están configurados, envía un correo de seguimiento con plantilla a quien envió. A menos que quien llama pueda administrar el formulario, submittedBy siempre se establece como la persona del miembro con sesión iniciada (o se deja vacío en los envíos anónimos)
DELETE/:idJWTForms.Admin o Forms.EditElimina un envío y sus respuestas

Preguntas​

Ruta base: /membership/questions

MétodoRutaAutenticaciónPermisoDescripción
GET/JWTAcceso al formularioEnumera las preguntas de un formulario. Requiere ?formId=
GET/:idJWTAcceso al formularioObtiene una pregunta por ID
GET/unrestricted?formId=JWT—Obtiene las preguntas de un formulario no restringido
GET/sort/:id/upJWT—Sube una pregunta en el orden
GET/sort/:id/downJWT—Baja una pregunta en el orden
POST/JWTAcceso al formularioCrea o actualiza preguntas (asigna el orden automáticamente)
DELETE/:id?formId=JWTAcceso al formularioElimina una pregunta

Respuestas​

Ruta base: /membership/answers

MétodoRutaAutenticaciónPermisoDescripción
GET/JWTForms.Admin o Forms.EditEnumera las respuestas. Filtre con ?formSubmissionId=
POST/JWTForms.Admin o Forms.EditCrea o actualiza respuestas

Permisos de miembros​

Ruta base: /membership/memberpermissions

Controla el acceso de cada miembro a formularios específicos.

MétodoRutaAutenticaciónPermisoDescripción
GET/:idJWTAcceso al formularioObtiene un permiso de miembro por ID
GET/member/:idJWTAcceso al formularioObtiene todos los permisos de formulario de un miembro
GET/form/:idJWTAcceso al formularioObtiene todos los permisos de miembros de un formulario
GET/form/:id/myJWTAcceso al formularioObtiene el permiso del usuario actual para un formulario
POST/JWTAcceso al formularioCrea o actualiza permisos de miembros
DELETE/:id?formId=JWTAcceso al formularioElimina un permiso de miembro
DELETE/member/:id?formId=JWTAcceso al formularioElimina todos los permisos de un miembro sobre un formulario

Configuración​

Ruta base: /membership/settings

MétodoRutaAutenticaciónPermisoDescripción
GET/JWTSettings.EditObtiene toda la configuración de la iglesia
GET/public/:churchIdPública—Obtiene la configuración pública de una iglesia
POST/JWTSettings.EditGuarda la configuración (admite la subida de imágenes en base64)

Dominios​

Ruta base: /membership/domains

Extiende el CRUD estándar (GET /:id, GET /, DELETE /:id de la clase base).

MétodoRutaAutenticaciónPermisoDescripción
GET/JWT—Enumera todos los dominios
GET/:idJWT—Obtiene un dominio por ID
GET/lookup/:domainNameJWT—Busca un dominio por nombre
GET/public/lookup/:domainNamePública—Búsqueda pública de dominio por nombre
GET/health/checkPública—Ejecuta una comprobación de salud de los dominios sin revisar
POST/JWTSettings.EditCrea o actualiza dominios (activa la actualización de Caddy)
DELETE/:idJWTSettings.EditElimina un dominio

UserChurch​

Ruta base: /membership/userchurch

Administra la asociación entre usuarios e iglesias.

MétodoRutaAutenticaciónPermisoDescripción
GET/userid/:userIdJWT—Obtiene el registro usuario-iglesia por ID de usuario
GET/personid/:personIdJWT—Obtiene el correo electrónico del usuario vinculado a una persona
GET/user/:userIdJWTServer.AdminCarga todas las iglesias de un usuario
POST/JWT—Crea una asociación usuario-iglesia
PATCH/:userIdJWT—Actualiza la hora del último acceso y registra el acceso
DELETE/record/:userId/:churchId/:personIdJWT—Elimina un registro usuario-iglesia

Preferencias de visibilidad​

Ruta base: /membership/visibilityPreferences

MétodoRutaAutenticaciónPermisoDescripción
GET/myJWT—Obtiene las preferencias de visibilidad del usuario actual
POST/JWT—Guarda las preferencias de visibilidad (visibilidad de dirección, teléfono y correo)

Consulta​

Ruta base: /membership/query

MétodoRutaAutenticaciónPermisoDescripción
POST/membersJWT—Búsqueda de miembros en lenguaje natural con IA. Cuerpo: { text, subDomain, siteUrl }

Errores del cliente​

Ruta base: /membership/clientErrors

MétodoRutaAutenticaciónPermisoDescripción
POST/JWT—Registra un error del lado del cliente

Páginas relacionadas​