Aller au contenu principal

Points de terminaison Membership

Le module Membership gère les personnes, les églises, les groupes, les foyers, les rôles, les autorisations, les formulaires et les paramètres. C'est le plus volumineux des modules ; il fournit la couche centrale d'identité et d'autorisation pour tous les autres modules.

Chemin de base : /membership

Personnes​

Chemin de base : /membership/people

MéthodeCheminAuthAutorisationDescription
GET/JWTPeople.View ou MemberLister toutes les personnes de l'église
GET/:idJWTPeople.View ou sa propre ficheObtenir une personne par ID (inclut les soumissions de formulaires)
GET/ids?ids=JWTPeople.View, Member ou People.ViewNamesObtenir plusieurs personnes par ID séparés par des virgules. Les appelants People.ViewNames sans People.View obtiennent le modèle de base, les personnes désabonnées étant exclues (sauf l'appelant)
GET/basic?ids=JWT—Obtenir les renseignements de base (nom seulement) pour plusieurs personnes
GET/names?ids=JWTToute autorisation de l'église[{ id, name: { display, first, last }, photo }], trié par nom de famille puis prénom, pour des identifiants séparés par des virgules que l'appelant possède déjà, afin que les rôles sans People.View (dons, présences) puissent identifier les personnes. Ni recherche ni filtre de répertoire
POST/namesJWTToute autorisation de l'égliseIdentique à GET /names. Corps : { peopleIds } (ou { ids })
GET/recentJWTPeople.View, Member ou People.ViewNamesPersonnes récemment ajoutées. Les appelants People.ViewNames sans People.View (même les membres ayant accès au répertoire) obtiennent le modèle de base (id, name.display, photo, membershipStatus) avec les personnes désabonnées exclues
GET/guest-register/options?churchId=Publique—Liste de contrôle de l'inscription des visiteurs par code QR : renvoie { email, phone, address, birthDate, gender, maritalStatus, grade, comments }, chacun valant "off", "optional" ou "required" (lu à partir du paramètre public guestRegistrationFields ; les valeurs manquantes ou mal formées reviennent à courriel/téléphone facultatifs, le reste désactivé). Exige enableQRGuestRegistration, sauf si la requête porte un jeton de site/d'église correspondant ; limité en débit (429)
GET/search?term=&email=JWTPeople.View, Member ou People.ViewNamesRechercher des personnes par nom ou par courriel (jusqu'à 100, triées par nom de famille puis prénom). Les appelants People.ViewNames sans People.View (même les membres ayant accès au répertoire) obtiennent une recherche par nom renvoyant le modèle de base ; une recherche par email renvoie []
GET/search/phone?number=JWTPeople.View ou MemberRechercher par numéro de téléphone
GET/search/group?groupId=JWTPeople.View ou MemberObtenir les personnes d'un groupe précis
GET/household/:householdIdJWT—Obtenir toutes les personnes d'un foyer
GET/attendanceJWTPeople.EditCharger les participants avec filtres (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWT—Charger les données de chronologie pour des personnes et des groupes
GET/directory/:idJWT—Obtenir une personne pour la vue du répertoire (respecte les préférences de visibilité)
GET/claim/:churchIdJWT—Revendiquer une fiche de personne pour l'utilisateur actuel dans une église
POST/JWTPeople.Edit ou EditSelfCréer ou mettre à jour des personnes (lot)
POST/searchJWTPeople.View, Member ou People.ViewNamesRechercher des personnes (variante POST). Corps : { term } ou { email } ; mêmes règles de noms seulement que GET /search
POST/advancedSearchJWTPeople.View ou MemberRecherche à plusieurs conditions (âge, birthMonth, membershipStatus, etc.). Le corps est un tableau de conditions ; un corps vide signifie aucune condition, et tout autre corps qui n'est pas un tableau renvoie 400
POST/loadOrCreatePublique—Trouver ou créer une personne par courriel. Corps : { churchId, email, firstName, lastName }
POST/guest-registerPublique—Inscription des visiteurs par code QR. Corps : { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (1 à 10 membres ; email/phone/maritalStatus s'appliquent seulement au premier membre). Les champs désactivés par l'église sont retirés ; les valeurs obligatoires manquantes ou invalides renvoient 400. D'abord, réutilise les personnes existantes : un membre correspond lorsqu'exactement une personne non supprimée a le même prénom (sans tenir compte de la casse) et le même courriel ou les mêmes chiffres de téléphone (domicile, travail ou mobile) ; un membre sans courriel ni téléphone correspond par prénom au sein du foyer correspondant. Les personnes correspondantes ne sont jamais modifiées. Les membres non associés rejoignent le foyer correspondant, ou sinon un nouveau foyer (nommé d'après le nom de famille du premier membre), avec membershipStatus: "Visitor" et l'address partagée. Enregistre comments comme note sur le premier membre, ajoute tout le monde au groupe privé guestRegistrationGroupId s'il est défini, et — lorsque guestRegistrationRecordAttendance vaut "true" — enregistre la présence aux horaires planifiés de ce groupe dont la fenêtre de pointage est ouverte maintenant. Renvoie { householdId, people: [{ id, name }] }, en reprenant les noms soumis plutôt que les noms enregistrés. Mêmes règles d'inscription/de jeton et de limitation de débit que l'appel des options
POST/household/:householdIdJWTPeople.EditMettre à jour les affectations des membres du foyer
POST/public/emailPublique—Envoyer un courriel à une personne. Corps : { churchId, personId, subject, body, appName }
POST/apiEmailsInterne—Charger les courriels de personnes par IDs (serveur à serveur, exige jwtSecret)
DELETE/:idJWTPeople.EditSupprimer une personne

Exemple : rechercher des personnes​

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

Exemple : créer une personne​

POST /membership/people
Authorization: Bearer <token>

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

Utilisateurs​

Chemin de base : /membership/users

Voir Authentification et autorisations pour les points de terminaison de connexion, d'inscription et de gestion des mots de passe.

MéthodeCheminAuthAutorisationDescription
POST/loginPublique—Se connecter (courriel/mot de passe, renouvellement JWT ou authGuid)
POST/registerPublique—Inscrire un nouvel utilisateur
POST/forgotPublique—Envoyer un courriel de réinitialisation du mot de passe
POST/setPasswordGuidPublique—Définir le mot de passe à l'aide du GUID d'authentification du lien courriel
POST/verifyCredentialsPublique—Vérifier le courriel/mot de passe et renvoyer les églises associées
POST/loadOrCreateJWT—Trouver ou créer un utilisateur par courriel/userId
POST/setDisplayNameJWT—Mettre à jour le prénom et le nom de l'utilisateur
POST/updateEmailJWT—Changer l'adresse courriel de l'utilisateur
POST/updatePasswordJWT—Changer le mot de passe de l'utilisateur (6 caractères minimum)
POST/updateOptedOutJWT—Régler le statut de désabonnement d'une personne
POST/sendInviteEmailJWTPeople.EditEnvoyer un courriel d'invitation à une personne de cette église (email, personName, contextName). Le bouton affiche Sign Up (S'inscrire) pour une personne sans compte, et Log In (Se connecter) pour un utilisateur existant. Un utilisateur qui ne s'est jamais connecté reçoit plutôt un lien Set Your Password (Définir votre mot de passe) valable 7 jours. Modèle fixe, donc il ne compte pas dans la limite quotidienne de courriels de l'église
GET/search?term=JWTServer.AdminRechercher tous les utilisateurs par nom ou courriel
DELETE/JWT—Supprimer le compte de l'utilisateur actuel

Églises​

Chemin de base : /membership/churches

MéthodeCheminAuthAutorisationDescription
GET/JWT—Charger toutes les églises de l'utilisateur actuel
GET/:idJWT—Obtenir une église par ID
GET/:id/getDomainAdminJWT—Obtenir l'utilisateur administrateur de domaine d'une église
GET/:id/impersonateJWTServer.AdminSe faire passer pour une église (administrateur du serveur seulement)
GET/all?term=JWTServer.AdminRechercher toutes les églises (administration)
GET/search/?name=Publique—Rechercher des églises par nom
GET/lookup/?subDomain=&id=Publique—Trouver une église par sous-domaine ou ID
POST/JWTSettings.EditMettre à jour les renseignements de l'église
POST/addJWT—Inscrire une nouvelle église. Champs obligatoires : name, address1, city, state, zip, country
POST/searchPublique—Rechercher des églises par nom (variante POST)
POST/selectJWT—Sélectionner/changer d'église. Corps : { churchId } ou { subDomain }
POST/:id/archiveJWTServer.AdminArchiver ou désarchiver une église
POST/byIdsPublique—Charger plusieurs églises par IDs
DELETE/deleteAbandonedJWTServer.AdminSupprimer les églises abandonnées depuis 7 jours ou plus

Groupes​

Chemin de base : /membership/groups

Hérite du CRUD standard (GET /, GET /:id de la classe de base).

MéthodeCheminAuthAutorisationDescription
GET/JWT—Lister tous les groupes
GET/:idJWT—Obtenir un groupe par ID
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Rechercher des groupes par filtres de service
GET/myJWT—Obtenir les groupes de l'utilisateur actuel
GET/my/:tagJWT—Obtenir les groupes de l'utilisateur actuel filtrés par étiquette
GET/tag/:tagJWT—Obtenir tous les groupes ayant une étiquette précise
GET/public/:churchId/:idPublique—Obtenir un groupe public par église et ID
GET/public/:churchId/tag/:tagPublique—Obtenir les groupes publics par étiquette
GET/public/:churchId/label?label=Publique—Obtenir les groupes publics par libellé
GET/public/:churchId/slug/:slugPublique—Obtenir un groupe public par slug
POST/JWTGroups.EditCréer ou mettre à jour des groupes (génère automatiquement le slug)
DELETE/:idJWTGroups.EditSupprimer un groupe (supprime aussi les équipes enfants pour les groupes de ministère)

Membres de groupe​

Chemin de base : /membership/groupmembers

Hérite du CRUD standard (GET /:id, DELETE /:id de la classe de base).

MéthodeCheminAuthAutorisationDescription
GET/:idJWTGroupMembers.ViewObtenir un membre de groupe par ID
GET/JWTGroupMembers.View*Lister les membres de groupe. Filtrer par ?groupId=, ?groupIds= ou ?personId=. *Aussi permis si l'utilisateur fait partie du groupe ou demande son propre personId, et pour ?groupId= de tout groupe non confidentiel lorsque l'utilisateur a Attendance.View ou Attendance.Edit (les membres de moins de 13 ans sont inclus pour eux)
GET/myJWT—Obtenir les appartenances aux groupes de l'utilisateur actuel
GET/basic/:groupIdJWT—Obtenir la liste de base des membres d'un groupe
GET/public/leaders/:churchId/:groupIdPublique—Obtenir les responsables d'un groupe (public)
GET/public/:churchId/:groupIdPublique—Obtenir la liste publique d'un groupe (champs minimaux : personId, displayName, leader, photo). Seulement lorsque le groupe accepte via publicRoster ; alimente l'élément staffGrid du générateur de site web
POST/JWTGroupMembers.EditAjouter ou mettre à jour des membres de groupe
DELETE/:idJWTGroupMembers.ViewRetirer un membre de groupe

Foyers​

Chemin de base : /membership/households

Contrôleur CRUD standard.

MéthodeCheminAuthAutorisationDescription
GET/JWT—Lister tous les foyers
GET/:idJWT—Obtenir un foyer par ID
POST/JWTPeople.EditCréer ou mettre à jour des foyers
DELETE/:idJWTPeople.EditSupprimer un foyer

Rôles​

Chemin de base : /membership/roles

MéthodeCheminAuthAutorisationDescription
GET/:idJWTRoles.ViewObtenir un rôle par ID
GET/church/:churchIdJWTRoles.ViewObtenir tous les rôles d'une église. Chaque rôle comprend memberCount, le nombre d'utilisateurs distincts qui en font partie
POST/JWTRoles.EditCréer ou mettre à jour des rôles
DELETE/:idJWTRoles.EditSupprimer un rôle (supprime aussi ses autorisations et ses membres)

Membres de rôle​

Chemin de base : /membership/rolemembers

MéthodeCheminAuthAutorisationDescription
GET/roles/:idJWTRoles.ViewObtenir les membres d'un rôle. Ajoutez ?include=users pour inclure les détails des utilisateurs
POST/JWTRoles.EditAjouter des membres à un rôle (crée l'utilisateur si le courriel n'existe pas)
DELETE/:idJWTRoles.ViewRetirer un membre de rôle
DELETE/self/:churchId/:userIdJWT—Se retirer d'une église

Autorisations de rôle​

Chemin de base : /membership/rolepermissions

MéthodeCheminAuthAutorisationDescription
GET/roles/:idJWTRoles.ViewObtenir les autorisations d'un rôle (utilisez null comme ID pour le rôle « Tout le monde »)
POST/JWTRoles.EditCréer ou mettre à jour des autorisations de rôle
DELETE/:idJWTRoles.EditSupprimer une autorisation de rôle

Autorisations​

Chemin de base : /membership/permissions

MéthodeCheminAuthAutorisationDescription
GET/JWT—Obtenir la liste complète des autorisations disponibles

Chaque entrée comporte apiName, section (type de contenu), action, ainsi que les libellés displaySection / displayAction affichés par l'éditeur de rôles de B1Admin. Ajouts récents : MembershipApi / People / View Names (Voir les noms des personnes uniquement, sous Personnes et groupes) et GivingApi / Donations / Enter (Saisir les dons, sous Dons ; voir Lots de dons).

Formulaires​

Chemin de base : /membership/forms

MéthodeCheminAuthAutorisationDescription
GET/JWTForms.Admin ou Forms.EditLister tous les formulaires (l'administrateur voit tout ; les éditeurs voient ceux qui leur sont assignés et les formulaires non réservés aux membres)
GET/:idJWTAccès au formulaireObtenir un formulaire par ID
GET/archivedJWTForms.Admin ou Forms.EditLister les formulaires archivés
GET/group/:groupIdJWTMembre du groupe, responsable du groupe ou Forms.AdminFormulaires autonomes liés au groupe (forms.groupId), à l'exclusion des archivés, triés par nom. Renvoie id, name, description et open (dans la fenêtre de disponibilité). Les membres n'obtiennent que les formulaires ouverts ; les responsables et les administrateurs de formulaires obtiennent aussi les fermés. Alimente la section des formulaires liés de la page du groupe
GET/standalone/:id?churchId=JWT—Obtenir un formulaire autonome (les formulaires restreints exigent une authentification)
POST/JWTForms.Admin ou Forms.EditCréer ou mettre à jour des formulaires. Les formulaires autonomes acceptent un photoUrl facultatif (photo d'en-tête affichée au-dessus du formulaire) et un groupId facultatif (groupe lié)
DELETE/:idJWTAccès au formulaireSupprimer un formulaire

Soumissions de formulaires​

Chemin de base : /membership/formsubmissions

MéthodeCheminAuthAutorisationDescription
GET/JWTForms.Admin ou Forms.EditLister les soumissions. Filtrer par ?personId= ou ?formId=
GET/my?include=questions,answersJWT—Portée personnelle : jusqu'à 50 soumissions de formulaires autonomes (pas de formulaires de personnes) que le membre connecté a soumises ou qui sont liées à sa personne (contentType person, contentId = son ID de personne — par exemple après un changement de personne par un administrateur), les plus récentes en premier, chacune avec form.name. include joint les questions de chaque formulaire et les réponses de la soumission. Renvoie 401 si l'utilisateur n'est pas lié à une personne. Alimente la section Mes formulaires de la page Moi de B1
GET/group/:groupIdJWTResponsable du groupeRéponses destinées aux responsables du groupe : une entrée par formulaire lié et par événement de groupe avec un formulaire d'inscription, chacune avec form, event (id, title, start ; entrées d'événement seulement), questions et submissions (avec answers et personName, null si anonyme)
GET/:idJWTForms.Admin, Forms.Edit ou accès en consultationObtenir une soumission par ID. Ajoutez ?include=form,questions,answers. Les responsables du groupe lié au formulaire, et les responsables du groupe auquel appartient une inscription à un événement, peuvent aussi la lire
GET/formId/:formIdJWTAccès au formulaire (consultation)Obtenir toutes les soumissions d'un formulaire (inclut le formulaire, les questions et les réponses). Les responsables du groupe lié au formulaire ont l'accès en consultation
POST/JWT—Soumettre des réponses de formulaire (gère les formulaires restreints et non restreints, envoie des notifications par courriel). Lorsque le formulaire a autoCreatePerson, trouve ou crée une personne Visiteur par courriel et lie la soumission ; lorsque le formulaire a aussi un groupId, ajoute cette personne au groupe ; lorsque followUpSubject/followUpBody sont définis, envoie un courriel de suivi à partir d'un modèle à la personne qui a soumis. Sauf si l'appelant peut gérer le formulaire, submittedBy est toujours réglé sur la personne du membre connecté (ou laissé vide pour les soumissions anonymes)
DELETE/:idJWTForms.Admin ou Forms.EditSupprimer une soumission et ses réponses

Questions​

Chemin de base : /membership/questions

MéthodeCheminAuthAutorisationDescription
GET/JWTAccès au formulaireLister les questions d'un formulaire. Exige ?formId=
GET/:idJWTAccès au formulaireObtenir une question par ID
GET/unrestricted?formId=JWT—Obtenir les questions d'un formulaire non restreint
GET/sort/:id/upJWT—Monter une question dans l'ordre de tri
GET/sort/:id/downJWT—Descendre une question dans l'ordre de tri
POST/JWTAccès au formulaireCréer ou mettre à jour des questions (attribue automatiquement l'ordre de tri)
DELETE/:id?formId=JWTAccès au formulaireSupprimer une question

Réponses​

Chemin de base : /membership/answers

MéthodeCheminAuthAutorisationDescription
GET/JWTForms.Admin ou Forms.EditLister les réponses. Filtrer par ?formSubmissionId=
POST/JWTForms.Admin ou Forms.EditCréer ou mettre à jour des réponses

Autorisations des membres​

Chemin de base : /membership/memberpermissions

Contrôle l'accès de chaque membre à des formulaires précis.

MéthodeCheminAuthAutorisationDescription
GET/:idJWTAccès au formulaireObtenir une autorisation de membre par ID
GET/member/:idJWTAccès au formulaireObtenir toutes les autorisations de formulaires d'un membre
GET/form/:idJWTAccès au formulaireObtenir toutes les autorisations de membres d'un formulaire
GET/form/:id/myJWTAccès au formulaireObtenir l'autorisation de l'utilisateur actuel pour un formulaire
POST/JWTAccès au formulaireCréer ou mettre à jour des autorisations de membres
DELETE/:id?formId=JWTAccès au formulaireSupprimer une autorisation de membre
DELETE/member/:id?formId=JWTAccès au formulaireSupprimer toutes les autorisations d'un membre sur un formulaire

Paramètres​

Chemin de base : /membership/settings

MéthodeCheminAuthAutorisationDescription
GET/JWTSettings.EditObtenir tous les paramètres de l'église
GET/public/:churchIdPublique—Obtenir les paramètres publics d'une église
POST/JWTSettings.EditEnregistrer les paramètres (prend en charge le téléversement d'images en base64)

Domaines​

Chemin de base : /membership/domains

Hérite du CRUD standard (GET /:id, GET /, DELETE /:id de la classe de base).

MéthodeCheminAuthAutorisationDescription
GET/JWT—Lister tous les domaines
GET/:idJWT—Obtenir un domaine par ID
GET/lookup/:domainNameJWT—Trouver un domaine par nom
GET/public/lookup/:domainNamePublique—Recherche publique d'un domaine par nom
GET/health/checkPublique—Lancer une vérification de santé sur les domaines non vérifiés
POST/JWTSettings.EditCréer ou mettre à jour des domaines (déclenche la mise à jour de Caddy)
DELETE/:idJWTSettings.EditSupprimer un domaine

Église de l'utilisateur​

Chemin de base : /membership/userchurch

Gère l'association entre les utilisateurs et les églises.

MéthodeCheminAuthAutorisationDescription
GET/userid/:userIdJWT—Obtenir l'enregistrement utilisateur-église par ID utilisateur
GET/personid/:personIdJWT—Obtenir le courriel de l'utilisateur lié à une personne
GET/user/:userIdJWTServer.AdminCharger toutes les églises d'un utilisateur
POST/JWT—Créer une association utilisateur-église
PATCH/:userIdJWT—Mettre à jour l'heure du dernier accès et consigner l'accès
DELETE/record/:userId/:churchId/:personIdJWT—Supprimer un enregistrement utilisateur-église

Préférences de visibilité​

Chemin de base : /membership/visibilityPreferences

MéthodeCheminAuthAutorisationDescription
GET/myJWT—Obtenir les préférences de visibilité de l'utilisateur actuel
POST/JWT—Enregistrer les préférences de visibilité (visibilité de l'adresse, du téléphone et du courriel)

Requête​

Chemin de base : /membership/query

MéthodeCheminAuthAutorisationDescription
POST/membersJWT—Recherche de membres en langage naturel à l'aide de l'IA. Corps : { text, subDomain, siteUrl }

Erreurs côté client​

Chemin de base : /membership/clientErrors

MéthodeCheminAuthAutorisationDescription
POST/JWT—Consigner une erreur côté client

Pages connexes​