# Unisoft — Documentation complète **Versions de l’API** · [V2 (Latest)](/integrations/v2/docs?lang=fr) · **V1** > **Cette version de l’API est obsolète.** Utilisez la dernière version pour toute nouvelle intégration. [Voir la documentation actuelle](/integrations/v2/docs?lang=fr) ## Votre premier appel Commencez par une lecture pour vérifier votre connexion avant toute écriture. ### 1. Préparer votre clé Dans le backoffice Unisoft, ouvrez Développeurs, créez une clé API et accordez uniquement les permissions nécessaires à votre intégration. Copiez la clé lors de sa création. ### 2. Choisir le bon environnement La production et le développement ont des domaines distincts. Utilisez une clé créée dans l’environnement appelé. ```shell PRODUCTION=https://api.unisoft.world/integrations/v1 DEVELOPMENT=https://kehilaapi.syn-assist.fr/integrations/v1 ``` ### 3. Vérifier la connexion ```shell export UNISOFT_API_URL='https://api.unisoft.world/integrations/v1' export UNISOFT_API_KEY='ke_live_REPLACE_WITH_YOUR_KEY' curl --fail-with-body "$UNISOFT_API_URL/me" \ --header "Authorization: Bearer $UNISOFT_API_KEY" ``` GET /me retourne l’organisation, les permissions de la clé et les langues activées. Vérifiez ces informations avant de continuer. ### Exemple ```json { "success": true, "data": { "apiKey": { "id": "key_example", "name": "Example integration", "prefix": "ke_live_", "scopes": [ "contacts:read" ] }, "organisation": { "id": "org_example", "name": "Example organisation", "shortName": "Example", "defaultLanguage": "fr", "enabledLanguages": [ "fr", "en" ] } } } ``` ### 4. Lire vos premiers contacts Cet appel nécessite la permission contacts:read. Les paramètres de recherche disponibles figurent dans la référence API. ```shell curl --fail-with-body "$UNISOFT_API_URL/contacts?limit=10" \ --header "Authorization: Bearer $UNISOFT_API_KEY" ``` ## Authentification Une clé, un périmètre et des permissions explicites. Transmettez votre clé dans Authorization: Bearer ou X-API-Key. Ne la placez jamais dans une URL ni dans le code public d’un site. ```shell Authorization: Bearer ke_live_REPLACE_WITH_YOUR_KEY ``` Une clé ke_live_ est rattachée à une seule organisation. Les permissions de lecture, d’écriture et d’envoi sont distinctes. Chaque opération indique les permissions acceptées. ### Comprendre une erreur 401 MISSING_API_KEY ou INVALID_API_KEY : vérifiez la clé, l’en-tête et l’environnement. 403 INSUFFICIENT_SCOPE : vérifiez les permissions requises par l’opération. Les autres erreurs métier sont décrites par opération. Conservez le code HTTP et le champ error pour diagnostiquer un échec. Après un délai d’attente sur une écriture ou un envoi, vérifiez le résultat avant de réessayer : toutes les opérations ne sont pas idempotentes. ## Données et pagination Les conventions à vérifier avant de lire ou modifier vos données. ### Parcourir une liste Les listes paginées exposent data et meta. Reprenez meta.nextCursor dans cursor tant que meta.hasMore vaut true, en conservant vos filtres. La limite habituelle est de 50 éléments, avec un maximum de 200 ; vérifiez les paramètres de chaque opération. ```shell GET /contacts?limit=50 GET /contacts?limit=50&cursor=NEXT_CURSOR ``` ### Montants et devises Les montants des paiements sont exprimés en unités mineures : 1500 représente 15,00 EUR. Les promesses utilisent des unités majeures. Vérifiez toujours le schéma du champ et sa devise. ### Modifier un contenu multilingue La langue principale de l’organisation se trouve à la racine de l’objet. Les autres langues sont des objets partiels sous leur code de langue. Lisez defaultLanguage et enabledLanguages dans GET /me. ```json { "label": "Restaurant", "en": {"label": "Restaurant"}, "he": {"label": "מסעדה"} } ``` Dans un PATCH, un champ absent reste inchangé. Un overlay de langue à null supprime cette traduction. Les règles de suppression des autres champs dépendent de leur schéma. **Contenu multilingue (à lire avant de renseigner un champ texte).** Le contenu traduisible n’utilise PAS une correspondance `{fr:…, en:…}`. À la place : - La valeur dans la **langue par défaut** de l’organisation (`org.language`) se trouve à la **RACINE** de l’objet — jamais sous sa propre clé de langue. - Chaque **autre** langue activée par l’organisation (`org.languages`) est une **surcharge partielle**, indexée par son code de langue et ne contenant que les champs traduisibles. ```json { "label": "Restaurant", "he": { "label": "מסעדה" } } // org default = French ``` Les clés de surcharge valides sont **dynamiques pour chaque organisation** : ses langues activées, moins la langue par défaut. L’envoi de la langue par défaut comme surcharge est rejeté (cela dupliquerait la racine) ; une langue non prise en charge est ignorée sans avertissement. Un champ absent d’une surcharge reprend la valeur de la racine. **Modifier ou supprimer une traduction** — lors d’une mise à jour partielle (`PATCH`), l’omission d’une clé signifie *« la laisser telle quelle »*. Par conséquent : | Corps | Effet sur la traduction `he` | |---|---| | `{"he": {"label": "מסעדה"}}` | créée ou remplacée | | *(clé omise)* | laissée intacte | | `{"he": null}` | **supprimée** (toute la surcharge `he` est retirée) | | `{"he": {}}` | également supprimée — une surcharge vide ne contient aucune traduction | Pour supprimer une traduction, envoyez explicitement null pour cette langue. Un objet de traduction vide est également traité comme une suppression ; omettre la langue préserve sa valeur actuelle. **La langue par défaut est contrôlée selon l’opération, et non selon la clé.** L’envoyer comme surcharge pour l’ÉCRIRE est rejeté (`{"fr": {"label": "…"}}` dans une organisation dont le français est la langue par défaut) — la langue par défaut doit se trouver à la racine. En revanche, `{"fr": null}` est accepté : cela SUPPRIME une surcharge dans cette langue. C’est important lorsqu’une organisation change de langue par défaut — une surcharge dans la nouvelle langue par défaut persiste dans les documents et prévaut sur la valeur racine lors de l’affichage ; sa suppression doit donc rester possible. Voir le schéma `I18nOverlay`. ## Recevoir les webhooks Recevez les événements Unisoft sur votre serveur et vérifiez leur signature. Dans Développeurs, configurez une destination HTTPS et les événements à recevoir. Conservez le secret affiché lors de la création ou de la rotation. Vérifiez la signature HMAC SHA-256 sur le corps brut et le timestamp avant de lire le JSON. Enregistrez l’événement avant de répondre avec un statut 2xx, puis traitez-le de façon asynchrone. ```shell signed_payload = X-Unisoft-Timestamp + "." + raw_body expected_signature = "sha256=" + HMAC_SHA256_HEX(secret, signed_payload) ``` Utilisez l’identifiant de l’événement pour éviter un traitement en double. Les livraisons peuvent être répétées ou arriver dans un ordre différent. Les formats, exemples, en-têtes et règles de nouvelle tentative sont détaillés dans le contrat des webhooks ci-dessous et dans x-webhooks du fichier OpenAPI. ### Webhooks de paiement Unisoft envoie une requête HTTP POST avec Content-Type: application/json à l’URL HTTPS configurée dans Developers > Outbound webhooks. Le secret d’intégration n’est affiché qu’une seule fois, à la création ou à la rotation ; aucune clé API n’est envoyée à votre opération. Vérifiez `X-Unisoft-Signature` par rapport à `"sha256=" + hex(HMAC-SHA256(secret, X-Unisoft-Timestamp + "." + rawBody))`. Utilisez les octets exacts de la requête brute, AVANT l’analyse du JSON (les fonctions HTTPS Firebase exposent `req.rawBody`). Utilisez une comparaison résistante aux attaques temporelles et rejetez les horodatages non numériques ou obsolètes ; la tolérance recommandée est de 300 secondes. L’horodatage est en secondes Unix et est renouvelé à chaque tentative. Accusez réception avec n’importe quelle réponse 2xx dans les 10 secondes ; le corps de la réponse est ignoré. Enregistrez l’événement ou placez-le en file avant l’accusé de réception, puis traitez-le de façon asynchrone. Dédupliquez par l’identifiant de l’enveloppe (également `X-Unisoft-Event-Id`) ; il reste stable lors des nouvelles tentatives de livraison, tandis que `attempt` augmente. `createdAt` est la date de mise en file, pas nécessairement la date du paiement. Les livraisons peuvent être dupliquées ou arriver dans le désordre. Les erreurs réseau, délais d’attente dépassés, réponses 5xx, 408 et 429 entraînent de nouvelles tentatives, jusqu’à 6. Les autres réponses 4xx sont définitives. Après 20 échecs consécutifs de l’intégration, la destination est mise en quarantaine pendant 24 heures. La livraison n’est pas garantie sans limite ; rapprochez les données avec GET /paiements si nécessaire. Les données de paiement sont un instantané du paiement au moment de l’émission, et non un événement bancaire normalisé. `amount` est exprimé en unités mineures, `devise` indique la devise, `contact` est un identifiant de contact (pas un objet contact) et `info` contient l’identité du donateur. Les champs supplémentaires varient selon le fournisseur et le type. `externalRef` et `externalMetadata` sont inclus s’ils existent ; les anciens paiements peuvent ne pas les contenir. Ne vous fiez pas aux champs propres à un fournisseur. Ces charges utiles peuvent contenir des données personnelles. #### paiement.success / paiement.refunded Abonnez-vous à paiement.success pour les paiements terminés et à paiement.refunded pour les remboursements confirmés. Les notifications de remboursement contiennent le paiement d’origine avec son état de remboursement mis à jour ; `amount` conserve le montant du paiement d’origine. La réponse synchrone de l’API de remboursement est un objet différent. Exemple de paiement.success (champs représentatifs ; des champs propres au fournisseur peuvent également être présents) : ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.success", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "COMPLETED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" } } } ``` Exemple de paiement.refunded (champs représentatifs ; des champs propres au fournisseur peuvent également être présents) : ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.refunded", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "REFUNDED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "refund": { "state": "SUCCEEDED", "reason": "requested_by_customer", "updatedAt": "2026-10-16T11:00:00.000Z" } } } ``` #### En-têtes | En-tête | Signification | |---|---| | X-Unisoft-Event | Identique à body.type | | X-Unisoft-Event-Id | Identique à body.id ; clé de déduplication | | X-Unisoft-Delivery-Id | Identifiant de l’enregistrement de livraison pour cette destination | | X-Unisoft-Timestamp | Secondes Unix | | X-Unisoft-Signature | sha256= suivi du HMAC en hexadécimal minuscule | #### Test de connectivité Le bouton Test du back-office envoie webhook.test via la file signée habituelle, indépendamment de la liste des événements auxquels vous êtes abonné. Il ne crée aucun paiement ni remboursement. Ses données contiennent `test:true`, `triggeredBy` (identifiant d’accès administrateur ou null) et `message`. Des schémas lisibles par machine propres à chaque événement sont également disponibles sous `x-webhooks` dans openapi.json. ## Connecter un assistant IA Le MCP expose les outils et leurs workflows métier aux clients compatibles. ```shell https://api.unisoft.world/integrations/mcp ``` Activez le MCP dans Développeurs puis connectez votre client compatible. L’autorisation et les permissions de l’organisation restent nécessaires. Le MCP publie cinq skills métier. Le client peut charger le workflow utile directement, sans téléchargement séparé. Le manifeste décrit aussi les fichiers disponibles. Pour un assistant qui lit des fichiers, utilisez l’index llms.txt ou les exports Markdown. Ils documentent l’API ; ils n’accordent aucun accès supplémentaire. ## Unisoft — API d’intégration OpenAPI 3.0.3 · API 1.0.0 ```json [ { "url": "https://api.unisoft.world/integrations/v1", "description": "API" } ] ``` API d’intégration Unisoft pour les outils no-code (Make, n8n, Zapier) et les agents d’IA (via le serveur MCP). **Deux mécanismes :** 1. **Opérations de l’API** documentées ci-dessous — accès en lecture aux contacts, paiements et abonnements ; gestion complète des **formulaires** (définitions et soumissions, y compris acceptation/refus), des **cagnottes** et des sites de **tourisme (Travel)** (configuration et lieux). Voir les rubriques correspondantes. 2. **Webhooks sortants** — Unisoft notifie une URL configurée lors de chaque événement métier (`paiement.success`, `paiement.refunded`, `form.submitted`, `contact.created`). Les charges utiles de paiement, exemples, en-têtes de signature et règles de livraison sont décrits dans l’extension fournisseur `x-webhooks` de cette spécification (le mot-clé racine `webhooks` est réservé à OAS 3.1 ; cette spécification est en 3.0). **Authentification :** en-tête `Authorization: Bearer ke_live_xxx` ou `X-API-Key: ke_live_xxx`. Les clés sont générées dans `Settings > Developers` du back-office Unisoft. Les opérations globaux de création de modèles d’email constituent la seule exception : ils nécessitent le jeton `kc_live_*`, sans organisation, configuré dans `EMAIL_TEMPLATE_CATALOG_TOKEN`. Leur spécification autonome plus légère est disponible à `/integrations/v1/email-template-catalog/openapi.json`. **Pagination :** basée sur un curseur. Réponse `{data: [...], meta: {nextCursor, hasMore}}`. Pour la page suivante, ajoutez `?cursor=`. **Isolation des organisations :** chaque clé ordinaire `ke_live_*` est liée à une organisation. Toutes ses réponses sont limitées à cette organisation. Le jeton de catalogue `kc_live_*` n’est lié à aucune organisation et peut accéder uniquement aux opérations globales de création du catalogue. ### Webhooks de paiement Unisoft envoie une requête HTTP POST avec Content-Type: application/json à l’URL HTTPS configurée dans Developers > Outbound webhooks. Le secret d’intégration n’est affiché qu’une seule fois, à la création ou à la rotation ; aucune clé API n’est envoyée à votre opération. Vérifiez `X-Unisoft-Signature` par rapport à `"sha256=" + hex(HMAC-SHA256(secret, X-Unisoft-Timestamp + "." + rawBody))`. Utilisez les octets exacts de la requête brute, AVANT l’analyse du JSON (les fonctions HTTPS Firebase exposent `req.rawBody`). Utilisez une comparaison résistante aux attaques temporelles et rejetez les horodatages non numériques ou obsolètes ; la tolérance recommandée est de 300 secondes. L’horodatage est en secondes Unix et est renouvelé à chaque tentative. Accusez réception avec n’importe quelle réponse 2xx dans les 10 secondes ; le corps de la réponse est ignoré. Enregistrez l’événement ou placez-le en file avant l’accusé de réception, puis traitez-le de façon asynchrone. Dédupliquez par l’identifiant de l’enveloppe (également `X-Unisoft-Event-Id`) ; il reste stable lors des nouvelles tentatives de livraison, tandis que `attempt` augmente. `createdAt` est la date de mise en file, pas nécessairement la date du paiement. Les livraisons peuvent être dupliquées ou arriver dans le désordre. Les erreurs réseau, délais d’attente dépassés, réponses 5xx, 408 et 429 entraînent de nouvelles tentatives, jusqu’à 6. Les autres réponses 4xx sont définitives. Après 20 échecs consécutifs de l’intégration, la destination est mise en quarantaine pendant 24 heures. La livraison n’est pas garantie sans limite ; rapprochez les données avec GET /paiements si nécessaire. Les données de paiement sont un instantané du paiement au moment de l’émission, et non un événement bancaire normalisé. `amount` est exprimé en unités mineures, `devise` indique la devise, `contact` est un identifiant de contact (pas un objet contact) et `info` contient l’identité du donateur. Les champs supplémentaires varient selon le fournisseur et le type. `externalRef` et `externalMetadata` sont inclus s’ils existent ; les anciens paiements peuvent ne pas les contenir. Ne vous fiez pas aux champs propres à un fournisseur. Ces charges utiles peuvent contenir des données personnelles. #### paiement.success / paiement.refunded Abonnez-vous à paiement.success pour les paiements terminés et à paiement.refunded pour les remboursements confirmés. Les notifications de remboursement contiennent le paiement d’origine avec son état de remboursement mis à jour ; `amount` conserve le montant du paiement d’origine. La réponse synchrone de l’API de remboursement est un objet différent. Exemple de paiement.success (champs représentatifs ; des champs propres au fournisseur peuvent également être présents) : ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.success", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "COMPLETED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" } } } ``` Exemple de paiement.refunded (champs représentatifs ; des champs propres au fournisseur peuvent également être présents) : ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.refunded", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "REFUNDED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "refund": { "state": "SUCCEEDED", "reason": "requested_by_customer", "updatedAt": "2026-10-16T11:00:00.000Z" } } } ``` #### En-têtes | En-tête | Signification | |---|---| | X-Unisoft-Event | Identique à body.type | | X-Unisoft-Event-Id | Identique à body.id ; clé de déduplication | | X-Unisoft-Delivery-Id | Identifiant de l’enregistrement de livraison pour cette destination | | X-Unisoft-Timestamp | Secondes Unix | | X-Unisoft-Signature | sha256= suivi du HMAC en hexadécimal minuscule | #### Test de connectivité Le bouton Test du back-office envoie webhook.test via la file signée habituelle, indépendamment de la liste des événements auxquels vous êtes abonné. Il ne crée aucun paiement ni remboursement. Ses données contiennent `test:true`, `triggeredBy` (identifiant d’accès administrateur ou null) et `message`. Des schémas lisibles par machine propres à chaque événement sont également disponibles sous `x-webhooks` dans openapi.json. **Contenu multilingue (à lire avant de renseigner un champ texte).** Le contenu traduisible n’utilise PAS une correspondance `{fr:…, en:…}`. À la place : - La valeur dans la **langue par défaut** de l’organisation (`org.language`) se trouve à la **RACINE** de l’objet — jamais sous sa propre clé de langue. - Chaque **autre** langue activée par l’organisation (`org.languages`) est une **surcharge partielle**, indexée par son code de langue et ne contenant que les champs traduisibles. ```json { "label": "Restaurant", "he": { "label": "מסעדה" } } // org default = French ``` Les clés de surcharge valides sont **dynamiques pour chaque organisation** : ses langues activées, moins la langue par défaut. L’envoi de la langue par défaut comme surcharge est rejeté (cela dupliquerait la racine) ; une langue non prise en charge est ignorée sans avertissement. Un champ absent d’une surcharge reprend la valeur de la racine. **Modifier ou supprimer une traduction** — lors d’une mise à jour partielle (`PATCH`), l’omission d’une clé signifie *« la laisser telle quelle »*. Par conséquent : | Corps | Effet sur la traduction `he` | |---|---| | `{"he": {"label": "מסעדה"}}` | créée ou remplacée | | *(clé omise)* | laissée intacte | | `{"he": null}` | **supprimée** (toute la surcharge `he` est retirée) | | `{"he": {}}` | également supprimée — une surcharge vide ne contient aucune traduction | Pour supprimer une traduction, envoyez explicitement null pour cette langue. Un objet de traduction vide est également traité comme une suppression ; omettre la langue préserve sa valeur actuelle. **La langue par défaut est contrôlée selon l’opération, et non selon la clé.** L’envoyer comme surcharge pour l’ÉCRIRE est rejeté (`{"fr": {"label": "…"}}` dans une organisation dont le français est la langue par défaut) — la langue par défaut doit se trouver à la racine. En revanche, `{"fr": null}` est accepté : cela SUPPRIME une surcharge dans cette langue. C’est important lorsqu’une organisation change de langue par défaut — une surcharge dans la nouvelle langue par défaut persiste dans les documents et prévaut sur la valeur racine lors de l’affichage ; sa suppression doit donc rester possible. Voir le schéma `I18nOverlay`. ### Opérations ### GET /utils/uuid Générer un UUID `generate_uuid` Générer un ou plusieurs UUID v4. La plupart des identifiants de ressource de cette API sont des UUID ; une intégration (ou un agent MCP/IA) a donc souvent besoin d’un nouvel identifiant valide avant de créer ou rattacher une ressource (par ex. choisir un identifiant de bloc de contenu puis écrire ce bloc). Aucune autorisation requise — toute clé valide est acceptée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": null, "additional": [] } ``` #### Paramètres ```json { "name": "count", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 1 }, "description": "Nombre d’UUID à générer (1–100). 1 par défaut." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Premier UUID généré (raccourci pratique pour le cas courant count=1)." }, "uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Tous les UUID générés." } } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /me Consulter la clé API, ses autorisations et son organisation `get_me` Lire l’identité de la clé appelante, ses autorisations accordées et son organisation, y compris defaultLanguage et enabledLanguages. Utilisez cette opération en lecture seule pour vérifier la clé et l’environnement avant toute écriture. Nécessite une clé API d’organisation valide ; aucune autorisation supplémentaire n’est requise. Le jeton global de catalogue kc_live_* ne peut pas appeler cette opération. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": null, "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "apiKey": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "organisation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "defaultLanguage": { "type": "string", "description": "Langue enregistrée à la racine des objets métier multilingues." }, "enabledLanguages": { "type": "array", "items": { "type": "string" }, "description": "Toutes les langues activées, y compris defaultLanguage. Les autres langues sont enregistrées sous forme de surcharges partielles." } } } } } } } } } } ``` ##### HTTP 401 ```json { "description": "Clé absente ou invalide", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /contacts Lister les contacts `list_contacts` Autorisation requise : `contacts:read`. Liste/filtre les contacts de l’organisation, chacun renvoyé dans sa structure complète (identité + sous-collections). `email`/`phone` sont ici des correspondances scalaires EXACTES (pour une recherche floue de doublon, utilisez GET /contacts/search). Résultats paginés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "createdAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filtre : créé après cette date (ISO 8601)." } ``` ```json { "name": "updatedAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Contacts modifiés après cette date uniquement." } ``` ```json { "name": "email", "in": "query", "schema": { "type": "string" }, "description": "Correspondance exacte (en minuscules) de l’email principal." } ``` ```json { "name": "phone", "in": "query", "schema": { "type": "string" }, "description": "Correspondance exacte du téléphone principal." } ``` ```json { "name": "tag", "in": "query", "schema": { "type": "string" }, "description": "Filtrer par catégorie (normalisée, par ex. \"Donateur\" → DONATEUR)." } ``` ```json { "name": "isLocal", "in": "query", "schema": { "type": "boolean" }, "description": "Filtrer par indicateur de proximité « local » (true/false)." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts Créer ou compléter un contact `create_contact` Autorisation requise : `contacts:write`. UPSERT INTELLIGENT : si un contact avec ce `phone` ou cet `email` (normalisé) existe déjà, il est MIS À JOUR uniquement pour remplir les champs vides — les valeurs d’identité existantes ne sont JAMAIS remplacées ; téléphones/emails/adresses/catégories/champs personnalisés secondaires sont ajoutés, et la réponse indique `created:false`. Seule une véritable insertion déclenche le webhook `contact.created`. Fournissez `?forceCreate=true` pour toujours insérer un nouveau document. Pour REMPLACER une valeur d’identité connue, utilisez plutôt PATCH /contacts/{id}. À la création, si aucun `tags` n’est fourni, la catégorie source `#API` est définie. Formats : `gender` "M"/"F"/null (jamais une civilité), `phone` tout format → E.164, `birthDate` ISO. `tags` sont des étiquettes booléennes ; `customFields` sont des paires clé/valeur typées (upsert par clé ; NUMBER/DATETIME enregistrés comme TEXT). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "forceCreate", "in": "query", "schema": { "type": "boolean" }, "description": "true → toujours insérer un nouveau contact, même si un téléphone/email correspond à un contact existant." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCreateInput" }, "example": { "firstName": "david", "lastName": "levy", "gender": "M", "email": "David.Levy@GMAIL.com ", "phone": "06 11 22 33 44", "tags": [ "Donateur" ], "customFields": [ { "key": "classe", "type": "TEXT", "value": "CM2" } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "created": { "type": "boolean", "description": "true = un nouveau contact a été inséré ; false = un contact existant a été mis à jour en remplissant uniquement les champs vides." }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/search Rechercher un contact par téléphone/email (dédoublonnage) `search_contacts` Autorisation requise : `contacts:read`. Recherche avant création pour dédoublonner : normalise `email`/`phone` et renvoie l’unique contact correspondant (`{found, contact}`) — ce n’est PAS une liste paginée. À utiliser avant create_contact pour savoir si le contact existe déjà. Fournissez au moins `email` ou `phone`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Paramètres ```json { "name": "email", "in": "query", "schema": { "type": "string" }, "description": "Email à faire correspondre (normalisé)." } ``` ```json { "name": "phone", "in": "query", "schema": { "type": "string" }, "description": "Téléphone à faire correspondre (normalisé)." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "found": { "type": "boolean" }, "contact": { "oneOf": [ { "$ref": "#/components/schemas/Contact" } ], "nullable": true } } } } } } } } ``` ##### HTTP 400 ```json { "description": "PARAMÈTRE_REQUIS", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_QUERY" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /contacts/import/schema Découvrir les champs et options importables `get_contact_import_schema` Autorisation requise : `contacts:read`. Guide d’importation auto-descriptif — appelez-le EN PREMIER pour découvrir chaque champ importable (avec ses alias pour associer les colonnes du tableur) et les options disponibles, puis exécutez normalisation → recherche → import dryRun → import. Renvoie `fields[]` ({key, label, type, kind, multi, example, description, aliases[]}) et `options` (dedupStrategy, defaultPhoneCountry, dateFormat, requireContact, applyTags). Reprend l’étape d’association des colonnes de la page ImportPage de l’admin. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContactImportSchema" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/normalize Normaliser les lignes d’un tableur (sans enregistrement) `normalize_contacts` Autorisation requise : `contacts:read`. Normalisation PURE des lignes de tableur non nettoyées, colonne par colonne — aucune base de données ni donnée d’organisation n’est modifiée. Pour chaque ligne, nettoie phone→E.164 (+ pays détecté), email, birthDate→ISO et civilité→`gender` "M"/"F", et signale les `issues`. ÉTAPE 2 du parcours d’import Excel (après get_contact_import_schema ; ensuite lookup_contacts, puis import_contacts dryRun). Exemple : `{phone:"06 12 34 56 78", birthDate:"15/03/1990", gender:"Mme", firstName:"sarah", category:"Séder night"}` → `{phone:{e164:"+33612345678", country:"FR", valid:true}, birthDate:{value:"1990-03-15", valid:true}, gender:"F", firstName:"Sarah", tags:["SEDER_NIGHT"]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNormalizeInput" }, "example": { "rows": [ { "phone": "06 12 34 56 78", "birthDate": "15/03/1990", "gender": "Mme", "firstName": "sarah", "category": "Séder night" } ], "defaultPhoneCountry": "FR" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/NormalizeResult" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/lookup Rechercher les correspondances par lot (sans écriture) `lookup_contacts` Autorisation requise : `contacts:read`. Pour chaque élément, recherche le contact correspondant de l’organisation SANS rien écrire (un contact supprimé logiquement n’est jamais réactivé). ÉTAPE 3 du parcours d’import Excel : exécutez après normalize_contacts pour repérer les lignes déjà présentes (`matchedContactId`) avant l’import. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactLookupInput" }, "example": { "items": [ { "phone": "+33611223344" }, { "email": "david.levy@gmail.com" } ], "defaultPhoneCountry": "FR" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/LookupResult" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/import Importer des contacts en masse (simulation + import réel) `import_contacts` Autorisation requise : `contacts:write`. Upsert en masse de 500 lignes maximum (500+ → 400 IMPORT_TOO_LARGE ; répartissez vous-même le fichier). ÉTAPE 4 du parcours Excel : appelez d’ABORD avec `dryRun:true` pour obtenir le PLAN par ligne (`report.lines[].action` = create/update/skip/error + `issues`), SANS rien enregistrer ; corrigez les lignes signalées `error`, puis rappelez avec `dryRun:false`. `options.dedupStrategy` = skip|update|create (update par défaut). Exemple de simulation `{contacts:[{__row:2, lastName:"cohen", phone:"061122", birthDate:"32/13/1990"}], dryRun:true}` → `report.lines:[{row:2, action:"error", issues:[{field:"phone", reason:"INVALID_PHONE", severity:"error"}, {field:"birthDate", reason:"INVALID_DATE", severity:"error"}]}]`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactImportInput" }, "example": { "contacts": [ { "__row": 2, "firstName": "sarah", "lastName": "cohen", "phone": "06 12 34 56 78", "birthDate": "15/03/1990" } ], "options": { "dedupStrategy": "update", "applyTags": [ "Import 2026" ] }, "dryRun": true } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ImportResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "IMPORT_TROP_VOLUMINEUX", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "IMPORT_TOO_LARGE" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/{id} Obtenir un contact `get_contact` Autorisation requise : `contacts:read`. Renvoie le contact complet (identité + addresses/secondaryPhones/secondaryEmails/tags/customFields/familyLinks). Renvoie 404 (jamais 403) si l’identifiant appartient à une autre organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /contacts/{id} Modifier l’identité d’un contact (remplacement explicite) `update_contact` Autorisation requise : `contacts:write`. REMPLACEMENT EXPLICITE des champs d’identité (liste autorisée + nouvelle normalisation) — contrairement à create_contact, cette opération REMPLACE la valeur enregistrée. Les sous-collections (téléphones/emails/adresses secondaires, catégories, customFields) ne sont PAS modifiées — utilisez les opérations dédiées aux sous-ressources. Une chaîne vide ("") signifie « ne pas modifier » (ajout uniquement : l’identité n’est jamais effacée). Une valeur invalide pour `email`, `phone` ou `birthDate` entraîne une erreur 400. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdateInput" }, "example": { "lastName": "LEVY", "gender": "M", "email": "d.levy@pro.com" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_EMAIL, INVALID_PHONE ou INVALID_DATE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_EMAIL, INVALID_PHONE or INVALID_DATE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/addresses Ajouter une adresse `add_contact_address` Autorisation requise : `contacts:write`. Ajoute une adresse : PRINCIPALE si le contact n’en possède aucune (ou si `main:true`), sinon adresse SECONDAIRE dédoublonnée (avec identifiant stable, modifiable ensuite). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAddressInput" }, "example": { "label": "Bureau", "type": "PRO", "address": "12 rue de la Paix", "postalCode": "75002", "city": "Paris" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "ADRESSE_MANQUANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_ADDRESS" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### PATCH /contacts/{id}/addresses/{addressId} Modifier une adresse secondaire `update_contact_address` Autorisation requise : `contacts:write`. Fusionne les champs fournis dans l’adresse SECONDAIRE désignée par `addressId` (UUID provenant de `adresses[].id`). Seuls les champs fournis sont modifiés. L’adresse PRINCIPALE n’a pas d’identifiant et ne peut pas être modifiée ici — utilisez PATCH /contacts/{id} ou POST /contacts/{id}/addresses avec main:true. 404 ADDRESS_NOT_FOUND si l’identifiant ne désigne pas une adresse secondaire de ce contact. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Identifiant de l’adresse secondaire (issu de `adresses[].id`)." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAddressPatchInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND ou ADDRESS_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND or ADDRESS_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/phones Ajouter un téléphone secondaire `add_contact_phone` Autorisation requise : `contacts:write`. Ajoute un téléphone SECONDAIRE (E.164, après dédoublonnage). Le téléphone principal se définit via create_contact / update_contact. 400 INVALID_PHONE si le numéro ne peut pas être analysé. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPhoneInput" }, "example": { "phone": "06 98 76 54 32", "phoneCountry": "FR" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_PHONE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_PHONE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/{id}/emails Ajouter un email secondaire `add_contact_email` Autorisation requise : `contacts:write`. Ajoute un email SECONDAIRE (après dédoublonnage). L’email principal se définit via create_contact / update_contact. 400 INVALID_EMAIL si l’email est invalide. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactEmailInput" }, "example": { "email": "perso@gmail.com" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_EMAIL", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_EMAIL" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/{id}/tags Ajouter une ou plusieurs catégories `add_contact_tags` Autorisation requise : `contacts:write`. Ajoute une ou plusieurs catégories (idempotent — une nouvelle attribution ne fait rien). Chacune est normalisée (majuscules, sans accents, espaces→`_`, par ex. "Séder night" → SEDER_NIGHT). Une catégorie est une étiquette booléenne — PAS un champ personnalisé clé/valeur (voir POST /contacts/{id}/custom-fields). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTagsInput" }, "example": { "tags": [ "Donateur régulier", "Séder night" ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "CATÉGORIES_MANQUANTES", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_TAGS" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /contacts/{id}/tags/{tag} Retirer une catégorie `remove_contact_tag` Autorisation requise : `contacts:write`. Retire UNE catégorie du contact (sans effet si elle est absente). `tag` est une chaîne libre (encodez `#FORM` dans l’URL) ; elle est normalisée de la même façon qu’à l’ajout. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Catégorie à retirer (encodée pour l’URL ; normalisée côté serveur)." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/custom-fields Définir des champs personnalisés (upsert par clé) `set_contact_custom_fields` Autorisation requise : `contacts:write`. Met à jour les champs personnalisés typés PAR CLÉ (réécrire la même clé met à jour le champ existant unique, sans doublon). `override` (true par défaut — modification explicite) remplace la valeur ; false ne remplit que les champs vides. `type` est réduit à TEXT/DATE/BOOL — NUMBER/DATETIME sont enregistrés comme TEXT. Les champs personnalisés sont distincts des catégories. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCustomFieldsInput" }, "example": { "customFields": [ { "key": "classe", "type": "TEXT", "value": "CM2" }, { "key": "casher", "type": "BOOL", "value": true } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "CHAMPS_PERSONNALISÉS_MANQUANTS", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_CUSTOM_FIELDS" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /contacts/{id}/custom-fields/{key} Supprimer un champ personnalisé `remove_contact_custom_field` Autorisation requise : `contacts:write`. Supprime un champ personnalisé par clé (insensible à la casse et au séparateur : `_` et `-` sont équivalents). Sans effet si le champ est absent. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Clé du champ à supprimer (encodée pour l’URL ; insensible à la casse/au séparateur)." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/family Ajouter un lien familial `add_contact_family_link` Autorisation requise : `contacts:write`. Ajoute un lien familial BIDIRECTIONNEL entre ce contact et `relatedContactId` (le lien inverse est ajouté automatiquement). `relatedContactId` DOIT appartenir à la même organisation (sinon 404 — aucun oracle inter-organisations). 400 UNKNOWN_RELATIONSHIP pour une valeur `relationship` hors énumération ; 400 SELF_LINK si le lien cible le contact lui-même. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactFamilyLinkInput" }, "example": { "relationship": "PARENT", "relatedContactId": "b3f1c2d4-5678-49ab-8cde-0123456789ab" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "UNKNOWN_RELATIONSHIP ou SELF_LINK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNKNOWN_RELATIONSHIP or SELF_LINK" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND ou RELATED_CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND or RELATED_CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /contacts/{id}/family/{relatedContactId} Supprimer un lien familial `remove_contact_family_link` Autorisation requise : `contacts:write`. Supprime le lien familial (et son inverse) entre ce contact et `relatedContactId`. `?relationship` précise quel lien supprimer. `relatedContactId` doit appartenir à l’organisation (sinon 404). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "relatedContactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Identifiant du contact associé." } ``` ```json { "name": "relationship", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "SPOUSE", "PARENT", "CHILD", "SIBLING", "GRANDPARENT", "GRANDCHILD", "IN_LAW", "EX", "COUSIN", "FRIEND" ] }, "description": "Lien familial à supprimer (OBLIGATOIRE — son omission renvoie 400 UNKNOWN_RELATIONSHIP)." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "UNKNOWN_RELATIONSHIP", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNKNOWN_RELATIONSHIP" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND ou RELATED_CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND or RELATED_CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/children Ajouter un enfant `add_contact_child` Autorisation requise : `contacts:write`. Ajoute un enfant en bas âge (sans téléphone/email) dont les parents sont ce contact et son éventuel conjoint SPOUSE détecté. Dédoublonnage par prénom parmi les enfants des parents : un enfant existant est réutilisé (`created:false`), sinon un nouveau contact enfant est créé. Un lien PARENT↔CHILD est créé automatiquement. Exemple `{firstName:"Rivka", birthDate:"2015-09-01"}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactChildInput" }, "example": { "firstName": "Rivka", "birthDate": "2015-09-01" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "created": { "type": "boolean", "description": "false = un enfant existant a été réutilisé." }, "childId": { "type": "string" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FIRST_NAME", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FIRST_NAME" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/{id}/interactions Lister les interactions d’un contact `list_contact_interactions` Autorisation requise : `contacts:read`. Renvoie les interactions consignées (appels, visites, notes) pour ce contact, de la plus récente à la plus ancienne, avec pagination par curseur. Une interaction est une entrée `contact_activity` — distincte d’un champ personnalisé ou d’une catégorie. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactInteraction" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/interactions Consigner une interaction `add_contact_interaction` Autorisation requise : `contacts:write`. Consigne un échange avec le contact (appel, visite, note). `type` est obligatoire — pour rester cohérent, réutilisez une valeur de GET /contacts/{id}/interactions/types. Exemple `{type:"Appel", content:"Rappelé pour la campagne de Pessah", actions:["Discussion"]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInteractionInput" }, "example": { "type": "Appel", "content": "Rappelé pour la campagne de Pessah", "actions": [ "Discussion" ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContactInteraction" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_TYPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_TYPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/{id}/interactions/types Lister les types d’interaction `list_contact_interaction_types` Autorisation requise : `contacts:read`. Renvoie les libellés distincts de `type` déjà utilisés dans l’organisation (ainsi que les valeurs courantes par défaut comme « Appel », « Visite »). Choisissez l’un d’eux lors de la consignation pour assurer la cohérence CRM et éviter les libellés presque identiques. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /contacts/{id}/documents Lister les documents d’un contact `list_contact_documents` Autorisation requise : `contacts:read`. Fichiers associés au contact (reçus, scans de pièce d’identité, mandats signés…), du plus récent au plus ancien. Chacun possède un `id` (pour le supprimer), un `name`, un `filename` hébergé et une `url` de téléchargement. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDocument" } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/documents Joindre un document `create_contact_document` Autorisation requise : `contacts:write`. Associe un document au contact. « Téléverser d’abord, joindre ensuite » : fournissez SOIT un `filename` déjà hébergé via POST /uploads/pdf|image, SOIT une `url` http(s) réhébergée côté serveur (image/PDF uniquement). `name` facultatif pour le libellé. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDocumentInput" }, "example": { "url": "https://example.com/receipt-2026.pdf", "name": "Reçu fiscal 2026" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContactDocument" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FILE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FILE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /contacts/{id}/documents/{docId} Détacher un document `delete_contact_document` Autorisation requise : `contacts:write`. Retire un document du contact par son `docId` (le fichier reste hébergé). Renvoie 404 si le contact ou l’identifiant du document est inconnu ici. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "contacts:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "docId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Identifiant du document renvoyé par GET /contacts/{id}/documents." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean" } } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "DOCUMENT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "DOCUMENT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /paiements Lister les paiements `list_paiements` Autorisation requise : `paiements:read`. Liste uniquement les paiements COMPLETED ou REFUNDED non supprimés, dans le périmètre de l’organisation et de la clé API. `externalRef` utilise une égalité exacte, sensible à la casse, et se combine avec les autres filtres ; plusieurs paiements peuvent partager cette valeur. Sans correspondance, renvoie une liste paginée vide. Les tentatives INIT, en attente et échouées restent exclues, même avec externalRef. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "paiements:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "createdAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filtre : créé après cette date (ISO 8601)." } ``` ```json { "name": "createdBefore", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filtre : créé avant cette date (ISO 8601)." } ``` ```json { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "GENERAL | SERVICE | CAISSE | DETTE | FORM" } ``` ```json { "name": "platform", "in": "query", "schema": { "type": "string" }, "description": "STRIPE | PAYGREEN | ..." } ``` ```json { "name": "contactId", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "externalRef", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S", "example": "commande-1234", "description": "Référence facultative dans votre système. Non vide, enregistrée telle quelle ; correspondance exacte sensible à la casse. Non unique et ne constitue PAS une clé d’idempotence. À distinguer de externalId (dédoublonnage à l’import). Renvoyée lors de la lecture des paiements et dans les webhooks de paiement si elle est fournie. Héritée par les paiements récurrents." }, "description": "Référence externe exacte, sensible à la casse ; encodez la valeur dans l’URL. Exemple : ?externalRef=commande-1234. Une valeur répétée/structurée ou invalide renvoie 400 INVALID_EXTERNAL_REF." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Paiement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_EXTERNAL_REF", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_EXTERNAL_REF" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /paiements Créer un lien de paiement autonome `create_paiements` Autorisation requise : `paiements:write`. Crée un enregistrement de paiement à l’état INIT et renvoie l’URL de la page de paiement hébergée (ou `clientSecret` pour les fournisseurs intégrés). L’entité cible (`typeId`) doit appartenir à l’organisation de la clé API. `config.organisation` est forcée côté serveur — toute valeur fournie par l’appelant est ignorée. `config` est validée avant traitement : `config.montant` doit être un nombre fini > 0 en unités majeures et ≤ 1000000 (sauf type SERVICE, dont le montant provient du service) ; `config.service` n’est accepté qu’avec type SERVICE ; chaque entrée `config.dettes[]` doit appartenir à votre organisation et avoir un montant fini > 0. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "paiements:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequest" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/PaymentResponse" } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_CONFIG / INVALID_MONTANT / MONTANT_TOO_LARGE / SERVICE_NOT_ALLOWED / INVALID_DETTES / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_CONFIG / INVALID_MONTANT / MONTANT_TOO_LARGE / SERVICE_NOT_ALLOWED / INVALID_DETTES / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA" } } } } } } ``` ##### HTTP 404 ```json { "description": "ORG_NOT_FOUND / TARGET_NOT_FOUND / DETTE_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ORG_NOT_FOUND / TARGET_NOT_FOUND / DETTE_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /paiements/import Importer un paiement déjà encaissé `import_paiement` Autorisation requise : `paiements:write`. Enregistre un don encaissé AILLEURS (chèque, virement, espèces, ancien logiciel, autre plateforme) comme paiement historique/comptable — enregistré avec `imported:true` et `state:"COMPLETED"`. Il alimente statistiques, compteurs de campagne, CRM et conversions de devise, mais aucun reçu/cerfa n’est émis de nouveau. Équivalent unitaire et validé des importateurs CLI en masse. Utilisez `POST /paiements` (et non cette opération) pour qu’un donateur paie en ligne maintenant. Idempotent si `externalId` est fourni (migration relançable sans risque). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "paiements:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaiementImportInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Paiement" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_AMOUNT / INVALID_METHOD / ASSOC_NOT_FOUND / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_AMOUNT / INVALID_METHOD / ASSOC_NOT_FOUND / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND / TARGET_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND / TARGET_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-scope": "paiements:write" } ``` ### GET /paiements/{id} Obtenir un paiement `get_paiement` Autorisation requise : `paiements:read`. Le détail reste disponible à l’état REFUND_PENDING pour inspecter un remboursement non confirmé. Vérifiez auprès de Nedarim tout remboursement Nedarim non confirmé avant de réessayer. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "paiements:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Paiement" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /paiements/{id}/refund Rembourser un paiement `refund_paiement` Autorisation requise : `paiements:write`. Déclenche un remboursement intégral auprès du fournisseur de paiement. Fournisseurs pris en charge : Stripe, Stripe externe, iPay, Nedarim et PayGreen. Le paiement doit appartenir à l’organisation de la clé API, être terminé, ne pas être groupé ni déjà remboursé. Nedarim conserve le reçu d’origine et émet un reçu négatif. Une réponse Nedarim ou PayGreen non confirmée laisse le paiement à l’état REFUND_PENDING : vérifiez auprès du fournisseur avant de demander un autre remboursement. PayGreen vérifie la référence de commande, la boutique, le montant, la devise et les fonds encaissés avant de demander un remboursement complet. Cette opération financière est irréversible. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "paiements:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRefundRequest" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Remboursement accepté", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRefundResponse" } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_REASON / INVALID_STATE / GROUPED_PAIEMENT / ALREADY_REFUNDED / REFUND_FAILED / NEDARIM_REFUND_UNCONFIRMED. Si pending vaut true, vérifiez la transaction dans Nedarim avant de réessayer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRefundResponse" } } } } ``` ##### HTTP 404 ```json { "description": "PAIEMENT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "PAIEMENT_NOT_FOUND" } } } } } } ``` ##### HTTP 405 ```json { "description": "METHOD_NOT_ALLOWED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "METHOD_NOT_ALLOWED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:write", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### GET /forms Lister les formulaires `list_forms` Autorisation requise : `forms:read`. Liste les formulaires de l’organisation (champs succincts). Résultats paginés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" }, "description": "Filtrer par état actif." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FormDefinition" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /forms Créer un formulaire `create_form` Autorisation requise : `forms:write`. Crée une DÉFINITION de formulaire à partir de l’objet métier de l’éditeur. La transpilation de `additionalFields` et l’enregistrement de `products` sont gérés côté serveur. Renvoie le formulaire créé dans la structure de l’éditeur. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormInput" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /forms/{id} Obtenir la définition d’un formulaire (produits, calendriers, contenu) `get_form` Autorisation requise : `forms:read`. Renvoie la même charge utile que le site public utilise pour afficher le formulaire (`content` transpilé), limitée à l’organisation de la clé API. Pour MODIFIER un formulaire, consultez plutôt `/forms/{id}/edit`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormDefinition" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /forms/{id} Modifier un formulaire `update_form` Autorisation requise : `forms:write`. Mise à jour partielle d’une DÉFINITION de formulaire (objet métier de l’éditeur). Seuls les champs fournis sont modifiés ; omettez `products`/`additionalFields` pour les laisser tels quels, envoyez-les pour remplacer l’ensemble. Renvoie le formulaire modifié dans la structure de l’éditeur. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormUpdateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormInput" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /forms/{id}/edit Obtenir un formulaire dans le format de l’éditeur `get_form_edit` Autorisation requise : `forms:read`. Renvoie l’objet métier de l’éditeur (produits intégrés, `additionalFields` reconstitués) — exactement la structure acceptée par `POST /forms` et `PATCH /forms/{id}`. Lisez cette ressource avant toute modification. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormInput" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /forms-submit Lister les soumissions de formulaire `list_forms_submit` Autorisation requise : `forms_submit:read` #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms_submit:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "createdAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filtre : créé après cette date (ISO 8601)." } ``` ```json { "name": "createdBefore", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filtre : créé avant cette date (ISO 8601)." } ``` ```json { "name": "formId", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "state", "in": "query", "schema": { "type": "string", "enum": [ "SUBMIT", "VALIDE", "INVALIDE" ] }, "description": "Filtrer par état de décision. SUBMIT = décision en attente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FormSubmit" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /forms-submit Soumettre un formulaire `create_forms_submit` Autorisation requise : `forms_submit:write`. Crée un document `forms_submit` et applique les mêmes effets secondaires que le site public (synchronisation CRM du contact, totaux, codes promotionnels, notifications, lien de paiement). Si un paiement est requis, `url` dans la réponse renvoie vers la page de paiement hébergée. Le mode modification (`data.extra.editId`) n’est pas pris en charge par cette opération. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms_submit:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitRequest" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SubmitResponse" } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FORM_ID ou EDIT_MODE_NOT_SUPPORTED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FORM_ID or EDIT_MODE_NOT_SUPPORTED" } } } } } } ``` ##### HTTP 404 ```json { "description": "FORM_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "FORM_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /forms-submit/with-payment Soumettre un formulaire et créer le lien de paiement en un seul appel `create_forms_submit_with_payment` Autorisations requises : `forms_submit:write` ET `paiements:write`. Même comportement que `POST /forms-submit` — opération pratique rendant explicites les autorisations requises lorsque l’appelant sait qu’un paiement est attendu. L’URL de paiement est renvoyée dans `url`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms_submit:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitRequest" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SubmitResponse" } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FORM_ID ou EDIT_MODE_NOT_SUPPORTED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FORM_ID or EDIT_MODE_NOT_SUPPORTED" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPES", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPES" } } } } } } ``` ##### HTTP 404 ```json { "description": "FORM_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "FORM_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /forms-submit/{id} Obtenir une soumission de formulaire `get_forms_submit` Autorisation requise : `forms_submit:read` #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms_submit:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormSubmit" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /forms-submit/{id}/validate Accepter une soumission (⚠️ envoie un email à son auteur) `validate_submission` Autorisation requise : `forms_submit:validate`. Définit la soumission à l’état VALIDE et ENVOIE un email de confirmation à son auteur — effet réel, d’où cette autorisation dédiée. Idempotent : renvoie `already:true` si la soumission était déjà VALIDE. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms_submit:validate", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:validate", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### POST /forms-submit/{id}/invalidate Refuser une soumission (sans email) `invalidate_submission` Autorisation requise : `forms_submit:validate`. Définit la soumission à l’état INVALIDE. N’envoie d’email à personne. Idempotent : renvoie `already:true` si la soumission était déjà INVALIDE. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "forms_submit:validate", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:validate", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /abonnements Lister les abonnements `list_abonnements` Autorisation requise : `abonnements:read` #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "abonnements:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" } } ``` ```json { "name": "contactId", "in": "query", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Abonnement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "abonnements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /abonnements/{id} Obtenir un abonnement `get_abonnement` Autorisation requise : `abonnements:read` #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "abonnements:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Abonnement" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "abonnements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /events Lister les événements autonomes `list_events` Autorisation requise : `events:read`. Liste les sessions d’événement AUTONOMES de l’organisation (« parcours d’événement »), chacune avec ses liens publics de formulaire/don. Les groupes à sessions multiples et les groupes système (par ex. Shabbat) sont exclus. Tri par date de début, de la plus récente à la plus ancienne. Résultats paginés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /events/{id} Obtenir un événement autonome `get_event` Autorisation requise : `events:read`. Renvoie un événement autonome par identifiant (avec ses liens publics). Renvoie 404 s’il ne s’agit pas d’un événement autonome de l’organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Event" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /promesses Lister les promesses de don `list_promesses` Autorisation requise : `promesses:read`. Liste les promesses de don de l’organisation, enrichies des champs calculés `payed`/`reste`/`status` et du nom du donateur. Exclut les promesses annulées sauf si `includeCanceled=true`. Résultats paginés, de la plus récente à la plus ancienne. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "promesses:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "contactId", "in": "query", "schema": { "type": "string" }, "description": "Filtrer par identifiant du contact donateur." } ``` ```json { "name": "typeId", "in": "query", "schema": { "type": "string" }, "description": "Filtrer par identifiant du livret/de la campagne associé(e)." } ``` ```json { "name": "occasion", "in": "query", "schema": { "type": "string" }, "description": "Filtrer par occasion (correspondance exacte)." } ``` ```json { "name": "includeCanceled", "in": "query", "schema": { "type": "boolean" }, "description": "Inclure les promesses annulées (false par défaut)." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promesse" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /promesses Créer une promesse de don `create_promesse` Autorisation requise : `promesses:write`. Crée une promesse pour un contact de l’organisation. `montant` est exprimé en unités MAJEURES de la devise (par ex. 50 = 50 €), PAS en centimes. La devise est toujours déduite de `assoc` (MAIN par défaut) et ne peut pas être remplacée. `organisation` est imposée côté serveur. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "promesses:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromesseCreate" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_MONTANT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_MONTANT" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_INTROUVABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /promesses/{id} Obtenir une promesse de don `get_promesse` Autorisation requise : `promesses:read`. Renvoie la promesse avec les valeurs `payed`/`reste`/`status` recalculées. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "promesses:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /promesses/{id} Modifier une promesse de don `update_promesse` Autorisation requise : `promesses:write`. Modifie n’importe quel sous-ensemble des champs modifiables de la promesse. `assoc`/`devise` ne sont PAS modifiables (fixés à la création). Les champs calculés (reste/payed/status) ne sont jamais acceptés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "promesses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromesseUpdate" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_MONTANT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_MONTANT" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND ou CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND or CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /promesses/{id} Annuler une promesse de don `delete_promesse` Autorisation requise : `promesses:write`. Supprime la promesse de manière logique (active=false, state=CANCELED) — elle disparaît des listes actives, mais n’est jamais supprimée physiquement. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "promesses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /promesses/{id}/payment-link Créer ou récupérer le lien de paiement d’une promesse `create_promesse_payment_link` Autorisation requise : `promesses:write`. Crée ou réutilise une URL de page de paiement hébergée afin que le donateur puisse honorer sa promesse. Renvoie 409 si la promesse est annulée, déjà entièrement payée ou couverte par un abonnement actif. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "promesses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/PromessePaymentLink" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "PLEDGE_FULFILLED, PLEDGE_CANCELED ou PLEDGE_COVERED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "PLEDGE_FULFILLED, PLEDGE_CANCELED or PLEDGE_COVERED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /associations Lister les associations de l’organisation `list_associations` Liste les associations juridiques de l’organisation (identifiant, libellé, devise) afin de choisir le bon `assoc` lors de la création d’une promesse ou d’un paiement. Aucune autorisation requise. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": null, "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /caisses Lister les cagnottes `list_caisses` Autorisation requise : `caisses:read`. Liste les cagnottes de collecte de l’organisation, chacune enrichie de `payed`/`reste`. Résultats paginés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" }, "description": "Filtrer par état actif." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Caisse" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses Créer une cagnotte `create_caisse` Autorisation requise : `caisses:write`. Crée une cagnotte de collecte. `bgimage` peut être une URL http(s) (réhébergée) ou un nom de fichier hébergé. Utilisez `typeId:"AUTO"` pour une cagnotte autonome. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaisseInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Caisse" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /caisses/{id} Obtenir une cagnotte `get_caisse` Autorisation requise : `caisses:read`. Renvoie la cagnotte enrichie des sommes collectées `payed`/`reste`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Caisse" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /caisses/{id} Modifier une cagnotte `update_caisse` Autorisation requise : `caisses:write`. Mise à jour partielle — seuls les champs fournis sont modifiés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaisseUpdateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Caisse" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/pause Mettre une cagnotte en pause `pause_caisse` Autorisation requise : `caisses:write`. Interrompt l’acceptation des contributions sans archiver la cagnotte. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/resume Reprendre une cagnotte en pause `resume_caisse` Autorisation requise : `caisses:write`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/archive Archiver une cagnotte `archive_caisse` Autorisation requise : `caisses:write`. Archive et désactive la cagnotte. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/unarchive Désarchiver une cagnotte `unarchive_caisse` Autorisation requise : `caisses:write`. Restaure une cagnotte archivée (la réactive). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/delete Désactiver une cagnotte `delete_caisse` Autorisation requise : `caisses:write`. Supprime logiquement la cagnotte (définit active=false). Le document est conservé. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "caisses:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /pages Lister les pages `list_pages` Autorisation requise : `pages:read`. Liste les pages de l’organisation (champs succincts + `url` concaténée). Résultats paginés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Page" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages Créer une page `create_page` Autorisation requise : `pages:write`. Crée une page IA (son contenu peut ensuite être défini via PUT /pages/{id}/content). `url` est normalisée en segments de slug et doit être unique. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Page" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR ou URL_ALREADY_USED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or URL_ALREADY_USED" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /pages/{id} Obtenir une page `get_page` Autorisation requise : `pages:read`. Page complète, incluant son SEO (metaTitle/metaDescription/metaImage et surcharges linguistiques), `html`/`i18n` et l’indicateur `aiEditable`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Page" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /pages/{id} Modifier les métadonnées d’une page `update_page` Autorisation requise : `pages:write`. Mise à jour partielle des métadonnées (label/title/description/url/active) et du SEO de page (metaTitle/metaDescription/metaImage, avec surcharges pour les autres langues). Fonctionne sur les pages IA et anciennes sans modifier leur contenu ni leur éditeur. Les champs et traductions omis sont conservés. Les champs SEO null/vides rétablissent les valeurs par défaut du site, puis les valeurs automatiques. Les images SEO HTTP(S) sont réhébergées, traductions comprises ; un échec d’importation refuse l’écriture. L’URL de la page d’accueil est verrouillée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageUpdateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Page" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR, URL_ALREADY_USED ou MAIN_PAGE_URL_LOCKED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or URL_ALREADY_USED or MAIN_PAGE_URL_LOCKED" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PUT /pages/{id}/content Définir le contenu IA (HTML) d’une page `set_page_content` Autorisation requise : `pages:write`. Définit le HTML de la page ; le serveur injecte les clés data-i18n et fusionne les traductions (voir PageContentInput). Refusé avec PAGE_CONTENT_NOT_EDITABLE pour les pages de l’ancien éditeur visuel. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageContentInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR ou PAGE_CONTENT_NOT_EDITABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or PAGE_CONTENT_NOT_EDITABLE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages/{id}/translations Définir les traductions d’une page `set_page_translations` Autorisation requise : `pages:write`. Met à jour, pour une langue, les traductions des clés data-i18n existantes. Ne modifie pas le HTML. Refusé pour les anciennes pages. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTranslationsInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR ou PAGE_CONTENT_NOT_EDITABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or PAGE_CONTENT_NOT_EDITABLE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages/{id}/activate Publier une page `activate_page` Autorisation requise : `pages:write`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages/{id}/deactivate Dépublier une page `deactivate_page` Autorisation requise : `pages:write`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "pages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /content-blocks Lister les blocs de contenu `list_content_blocks` Autorisation requise : `content_blocks:read`. Liste les blocs de contenu de l’organisation (champs succincts). Résultats paginés. Pour savoir QUEL bloc alimente un emplacement, consultez la configuration qui le référence — par ex. `homepage.aiContentBlockId` de Travel. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "content_blocks:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContentBlock" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /content-blocks/{id} Obtenir un bloc de contenu `get_content_block` Autorisation requise : `content_blocks:read`. Bloc complet, avec `html`, `i18n` et `mainLang`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "content_blocks:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifiant de bloc de contenu — toute chaîne stable de votre choix (UUID recommandé ; générez-en un avec GET /utils/uuid). PUT /content-blocks/{id}/content effectue un upsert ; cet identifiant n’a donc pas besoin d’exister au préalable." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContentBlock" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PUT /content-blocks/{id}/content Définir le contenu HTML d’un bloc `set_content_block_content` Autorisation requise : `content_blocks:write`. Définit le HTML du bloc ; le serveur injecte les clés data-i18n et fusionne les traductions (voir les règles de rédaction HTML obligatoires de ContentBlockContentInput). Upsert : si l’identifiant n’existe pas, le bloc est créé. Vous pouvez donc écrire un bloc, puis le lier à la page d’accueil Travel (`PATCH /travel/{travelId}/config/homepage` avec `aiContentBlockId`) ou à un groupe d’événements. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "content_blocks:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifiant de bloc de contenu — toute chaîne stable de votre choix (UUID recommandé ; générez-en un avec GET /utils/uuid). PUT /content-blocks/{id}/content effectue un upsert ; cet identifiant n’a donc pas besoin d’exister au préalable." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentBlockContentInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /content-blocks/{id}/translations Définir les traductions d’un bloc de contenu `set_content_block_translations` Autorisation requise : `content_blocks:write`. Met à jour, pour une langue, les traductions des clés data-i18n existantes. Ne modifie pas le HTML. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "content_blocks:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifiant de bloc de contenu — toute chaîne stable de votre choix (UUID recommandé ; générez-en un avec GET /utils/uuid). PUT /content-blocks/{id}/content effectue un upsert ; cet identifiant n’a donc pas besoin d’exister au préalable." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentBlockTranslationsInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /email-templates Lister les modèles d’email `list_email_templates` Autorisation requise : `email_templates:read`. Liste les modèles d’email de l’organisation (champs succincts, sans html). Résultats paginés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplate" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates Créer un modèle d’email `create_email_template` Autorisation requise : `email_templates:write`. Crée un modèle. `html` est facultatif (créez un modèle vide, puis remplissez-le via PUT /{id}/content). Après la création, associez son identifiant à une campagne comme email de remerciement au donateur (`campagnes.config.donorEmailTemplate`). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCreateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplate" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/{id} Obtenir un modèle d’email `get_email_template` Autorisation requise : `email_templates:read`. Modèle complet, avec `html`, `design` et `assets`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplate" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /email-templates/{id} Renommer un modèle d’email `update_email_template` Autorisation requise : `email_templates:write`. Renomme le modèle (métadonnées uniquement ; utilisez PUT /{id}/content pour modifier le HTML). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateRenameInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /email-templates/{id} Supprimer un modèle d’email `delete_email_template` Autorisation requise : `email_templates:write`. Supprime logiquement le modèle. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### PUT /email-templates/{id}/content Définir le contenu HTML d’un modèle `update_email_template_content` Autorisation requise : `email_templates:write`. Définit le HTML du modèle (régénère l’aperçu, au mieux). Respectez les règles de compatibilité des clients de messagerie de EmailTemplateContentInput. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateContentInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplate" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /galleries Lister les galeries photo `list_galleries` Autorisation requise : `galleries:read`. Liste les galeries actives de l’organisation (sans `images[]` ; chacune contient `nbImages` et une image de couverture). Résultats paginés. Filtrez avec `?category` (catégorie), `?search` (recherche plein texte) ou `?contact` (identifiant d’un contact CRM). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "Filtrer les galeries ayant cette catégorie." } ``` ```json { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Recherche plein texte dans les galeries." } ``` ```json { "name": "contact", "in": "query", "schema": { "type": "string" }, "description": "Filtrer les galeries associées à cet identifiant de contact CRM." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Gallery" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /galleries Créer une galerie photo `create_gallery` Autorisation requise : `galleries:write`. Crée un album vide. Ajoutez ensuite des photos via POST /galleries/{id}/images. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryCreateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Gallery" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /galleries/categories Lister les catégories de galerie `list_gallery_categories` Autorisation requise : `galleries:read`. Renvoie les catégories distinctes utilisées dans les galeries de l’organisation (utile pour renseigner le filtre `category` ou réutiliser une catégorie existante lors d’une création/modification). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /galleries/{id} Obtenir une galerie photo `get_gallery` Autorisation requise : `galleries:read`. Renvoie les métadonnées de l’album, `nbImages` et l’image de couverture (PAS la liste complète des images — utilisez GET /galleries/{id}/images). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Gallery" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /galleries/{id} Modifier une galerie photo `update_gallery` Autorisation requise : `galleries:write`. Mise à jour partielle des métadonnées de l’album (nom/description/catégories/compte/contact). Les images se gèrent via les opérations dédiées. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryUpdateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Gallery" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /galleries/{id} Supprimer une galerie photo `delete_gallery` Autorisation requise : `galleries:write`. Supprime logiquement l’album (masqué du site et des listes ; le document est conservé). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /galleries/{id}/images Lister les images d’une galerie `list_gallery_images` Autorisation requise : `galleries:read`. Renvoie une page de noms de fichiers image de l’album ("md5.ext") et leurs URL publiques dans `meta.imageUrls`. Pagination par page : `?page` (indexée à partir de 1) et `?limit` (30 par défaut). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 30 } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /galleries/{id}/images Ajouter des images à une galerie `add_gallery_images` Autorisation requise : `galleries:write`. Ajoute des images à l’album. Envoyez SOIT un ou plusieurs champs de fichier image multipart/form-data (5 Mo maximum chacun, image/* uniquement), SOIT un corps JSON {images:[url|filename]} (les URL http(s) sont réhébergées côté serveur ; les noms de fichiers "md5.ext" déjà hébergés sont joints tels quels). Les doublons sont ignorés. Un agent MCP/IA doit utiliser le format JSON avec des URL. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryAddImagesInput" } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Un ou plusieurs fichiers image (répétez le champ pour en envoyer plusieurs)." } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "added": { "type": "array", "items": { "type": "string" } }, "addedUrls": { "type": "array", "items": { "type": "string", "format": "uri" } }, "nbImages": { "type": "integer" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /galleries/{id}/images Retirer des images d’une galerie `remove_gallery_images` Autorisation requise : `galleries:write`. Détache les images de l’album par leur nom de fichier hébergé. Les fichiers physiques ne sont pas supprimés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryRemoveImagesInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "removed": { "type": "array", "items": { "type": "string" } }, "nbImages": { "type": "integer" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /galleries/{id}/images/reorder Réorganiser les images d’une galerie `reorder_gallery_images` Autorisation requise : `galleries:write`. Définit l’ordre d’affichage des images de l’album. `order` doit être une permutation des noms de fichiers actuels ; les images omises sont ajoutées à la fin dans leur ordre actuel (aucune n’est perdue). La première image devient la couverture. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "galleries:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryReorderImagesInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string" } } } } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /campaigns Lister les campagnes `list_campaigns` Autorisation requise : `messages:read`. Liste les campagnes de l’organisation avec leurs statistiques de livraison. Résultats paginés. Filtrez avec `?state` (INIT|VALIDATE|FINISHED) ou `?type`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "state", "in": "query", "schema": { "type": "string", "enum": [ "INIT", "VALIDATE", "FINISHED" ] } } ``` ```json { "name": "type", "in": "query", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /campaigns Créer une campagne (brouillon) `create_campaign` Autorisation requise : `messages:write`. Crée une campagne à l’état INIT (brouillon). N’effectue PAS l’envoi — utilisez POST /{id}/send. Le ciblage est exclusif (allContact | staredOnly | categories). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /campaigns/sms/available Consulter le quota SMS restant `get_sms_quota` Autorisation requise : `messages:read`. Renvoie le nombre de crédits SMS restants de l’organisation (utile avant l’envoi d’une campagne SMS). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "total": { "type": "integer" } } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /campaigns/{id} Obtenir une campagne `get_campaign` Autorisation requise : `messages:read`. Campagne complète, avec ses statistiques de livraison. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /campaigns/{id} Modifier une campagne en brouillon `update_campaign` Autorisation requise : `messages:write`. Modifie une campagne uniquement tant qu’elle est à l’état INIT (brouillon). Renvoie 409 si elle a déjà été envoyée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CAMPAIGN_NOT_EDITABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CAMPAIGN_NOT_EDITABLE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /campaigns/{id} Supprimer une campagne `delete_campaign` Autorisation requise : `messages:write`. Supprime logiquement la campagne. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /campaigns/{id}/duplicate Dupliquer une campagne `duplicate_campaign` Autorisation requise : `messages:write`. Duplique la campagne sous forme de nouveau brouillon INIT (nouvel identifiant, scheduledAt effacé, statistiques réinitialisées ; médias partagés par référence). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /campaigns/{id}/targets Prévisualiser le nombre de destinataires `preview_campaign_targets` Autorisation requise : `messages:read`. Compte les destinataires correspondant au ciblage enregistré de la campagne, SANS créer de livraison. Renvoie 0 si aucun ciblage n’est défini. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/CampaignTargets" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /campaigns/{id}/send Envoyer la campagne (envoi massif réel) `send_campaign` Autorisation requise : `messages:send`. **Déclenche l’envoi massif réel.** Fait passer le brouillon de INIT à VALIDATE et met en file une livraison par destinataire correspondant ; les processus envoient ensuite via WhatsApp/SMS/email. Action **irréversible**, susceptible d’entraîner des frais SMS, un risque de blocage du numéro WhatsApp (limites de débit) et des implications RGPD (messages envoyés à de vrais contacts). Prévisualisez d’abord l’audience avec POST /{id}/targets. Idempotent : une campagne déjà envoyée (state ≠ INIT) renvoie 409. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:send", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "state": { "type": "string" }, "targets": { "type": "integer" } } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CAMPAIGN_ALREADY_SENT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CAMPAIGN_ALREADY_SENT" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:send", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### POST /campaigns/{id}/test Envoyer un test à un contact (brouillon uniquement) `test_campaign` Autorisation requise : `messages:send`. Envoie un seul message de test de la campagne à un contact (envoi réel à cette personne ; exclu des statistiques ; ignore la liste de désinscription). Autorisé UNIQUEMENT tant que la campagne est en brouillon (state INIT) — sinon renvoie 409. Corps : {contactId}. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:send", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignTestInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CAMPAIGN_NOT_DRAFT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CAMPAIGN_NOT_DRAFT" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:send", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### POST /uploads Téléverser un fichier média (tout type) `create_upload` Autorisation requise : `uploads:write` (une clé `messages:write` est AUSSI acceptée pour le parcours de campagne). Téléverse une image/PDF/vidéo (multipart/form-data) et renvoie le nom de fichier hébergé + l’URL, à ASSOCIER ensuite à sa ressource (document de contact, média de campagne…). REMARQUE : multipart uniquement — un agent MCP/IA incapable d’envoyer un flux binaire doit transmettre une URL http(s) dans `url` à l’opération qui consomme le fichier (par ex. POST /contacts/{id}/documents), qui le réhéberge côté serveur. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "uploads:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/UploadResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "UNSUPPORTED_MEDIA_TYPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNSUPPORTED_MEDIA_TYPE" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "uploads:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /uploads/image Téléverser une image `create_upload_image` Autorisation requise : `uploads:write`. Téléverse uniquement une image (image/*, ≤ 5 Mo, multipart/form-data) et renvoie son nom de fichier hébergé + son URL. Suit le fonctionnement du téléversement d’images admin. Multipart uniquement (voir la remarque de POST /uploads pour MCP/IA). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "uploads:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/UploadResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "WRONG_MEDIA_FAMILY", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "WRONG_MEDIA_FAMILY" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "uploads:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /uploads/pdf Téléverser un PDF `create_upload_pdf` Autorisation requise : `uploads:write`. Téléverse uniquement un PDF (application/pdf, ≤ 15 Mo, multipart/form-data) et renvoie son nom de fichier hébergé + son URL. Suit le fonctionnement du téléversement de documents admin. Multipart uniquement (voir la remarque de POST /uploads pour MCP/IA). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "uploads:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/UploadResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "WRONG_MEDIA_FAMILY", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "WRONG_MEDIA_FAMILY" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "uploads:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /whatsapp-accounts Lister les numéros WhatsApp connectés `list_whatsapp_accounts` Autorisation requise : `messages:read`. Liste les numéros WhatsApp connectés de l’organisation. Choisissez l’identifiant d’un numéro `ready` pour le définir comme whatsappAccountId de campagne. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsappAccount" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /whatsapp-accounts/{id}/status Consulter l’état d’un numéro WhatsApp `get_whatsapp_account_status` Autorisation requise : `messages:read`. État actuel d’un numéro (`ready` = connecté et utilisable). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/WhatsappAccountStatus" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /messaging-configs Lister les configurations d’envoi email et SMS `list_messaging_configs` Autorisation requise : `messages:read`. Configurations d’envoi email et SMS de l’organisation (sans secrets). Utilisez l’identifiant d’une configuration email comme `emailConfig` de campagne. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "messages:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MessagingConfigs" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /menu Lister les éléments de menu (arborescence d’un site) `list_menu` Autorisation requise : `web_menu:read`. Renvoie les éléments du site (à plat, triés par position ; reconstruisez l’arborescence avec parent/position). Transmettez `?virtualId` pour cibler un site (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "web_menu:read", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Identifiant du site ; omettre pour le site principal." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MenuItem" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /menu Créer un élément de menu `create_menu_item` Autorisation requise : `web_menu:write`. Crée un élément à la fin du niveau racine. Utilisez `targetId` pour les éléments PAGE/FORM/CAGNOTTE. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "web_menu:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItemInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MenuItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /menu/reorder Réorganiser/déplacer les éléments du menu `reorder_menu` Autorisation requise : `web_menu:write`. Définit le parent et la position des éléments en une seule opération (arborescence/glisser-déposer). Envoyez la disposition complète souhaitée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "web_menu:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuReorderInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /menu/{id} Modifier un élément de menu `update_menu_item` Autorisation requise : `web_menu:write`. Modifie uniquement le contenu (pas le parent/la position). Transmettez le `virtualId` de l’élément dans le corps. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "web_menu:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItemInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MenuItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /menu/{id} Supprimer un élément de menu `delete_menu_item` Autorisation requise : `web_menu:write`. Transmettez `?virtualId` pour limiter l’opération au site. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "web_menu:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /travel Lister les sites Travel `list_travel` Autorisation requise : `travel:read`. Liste les sites touristiques de l’organisation pour découvrir leur `travelId`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TravelSite" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERREUR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId} Obtenir un site Travel (configuration et lieux) `get_travel` Autorisation requise : `travel:read`. Renvoie la configuration assainie et toutes les collections de lieux enrichies, ainsi qu’un ensemble `shabbat` (groupe Shabbat du site et sessions à venir, comme GET /travel/{travelId}/shabbat). Les instructions système du chatbot et les clés API des fournisseurs ne sont jamais incluses. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/config Obtenir la configuration du site `list_travel_config` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/shabbat Obtenir les sessions Shabbat du site `get_travel_shabbat` Autorisation requise : `travel:read`. Renvoie le groupe Shabbat du site (métadonnées publiques et identifiant du bloc d’introduction IA) et ses sessions à venir/actives (même structure que les événements autonomes). Renvoie `{group:null, sessions:[]}` si aucun Shabbat n’est configuré. Les zmanim (heures d’entrée/sortie) ne sont pas inclus dans cette version. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ShabbatBundle" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/theme Modifier la section de configuration : thème `update_travel_config_theme` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigTheme" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigTheme" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/jewish-info Modifier les informations pratiques juives (jewishInfo) `update_travel_config_jewish_info` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigJewishInfo" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigJewishInfo" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/horaires Modifier la section de configuration : horaires `update_travel_config_horaire` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigHoraires" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigHoraires" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/menu Modifier la section de configuration : menu `update_travel_config_menu` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigMenu" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigMenu" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/hero Modifier la bannière principale (heroBanner) `update_travel_config_hero` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigHeroBanner" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigHeroBanner" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/homepage Modifier la page d’accueil (homepage) `update_travel_config_homepage` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigHomepage" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigHomepage" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/beth-habad Modifier la section Beth Habad (bethHabad) `update_travel_config_beth_habad` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigBethHabad" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigBethHabad" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/services Modifier la section de configuration : services `update_travel_config_service` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigServices" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigServices" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/faq Modifier les questions fréquentes (faq) `update_travel_config_faq` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigFaq" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigFaq" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/journey Modifier les paramètres des annonces de voyage (journey) `update_travel_config_journey` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigJourney" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigJourney" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/chatbot Modifier le chatbot du site (chatbot) `update_travel_config_chatbot` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigChatbot" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigChatbot" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/booking-api Modifier l’API de réservation (bookingApi) `update_travel_config_booking_api` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigBookingApi" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigBookingApi" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/airbnb-api Modifier l’intégration Airbnb (airbnbApi) `update_travel_config_airbnb_api` Autorisation requise : `travel:write`. Remplace uniquement cette section (les sections voisines ne changent pas). Utilise la structure i18n native (langue par défaut de l’organisation à la racine, autres langues sous forme de surcharges). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigAirbnbApi" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigAirbnbApi" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/beth-habad-label Modifier le libellé « Beth Habad » (i18n) `update_travel_config_beth_habad_label` Autorisation requise : `travel:write`. Corps : `{value, ?…}` (chaînes simples). `value` est le libellé dans la langue par DÉFAUT de l’organisation (`org.language`). Chaque autre clé est une traduction indexée par code de langue — les clés valides sont les langues activées de l’organisation, SAUF la langue par défaut (l’envoi de la langue par défaut comme clé est refusé). Les propriétés ci-dessous (en/he/de/gr) sont les cas courants ; fr/it/ru/pt sont également acceptés si activés par l’organisation. Définissez une traduction à **null** pour la SUPPRIMER (l’omission de la clé la laisse intacte). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "Libellé dans la langue par défaut de l’organisation (org.language)" }, "en": { "type": "string", "nullable": true, "description": "Traduction anglaise (si \"en\" est une langue activée autre que la langue par défaut). null la supprime." }, "he": { "type": "string", "nullable": true, "description": "Traduction hébraïque (si activée et différente de la langue par défaut). null la supprime." }, "de": { "type": "string", "nullable": true, "description": "Traduction allemande (si activée et différente de la langue par défaut). null la supprime." }, "gr": { "type": "string", "nullable": true, "description": "Traduction grecque (si activée et différente de la langue par défaut). null la supprime." } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/categories/{type} Modifier la liste de catégories (kosher | hotel | attraction) `update_travel_config_category` Autorisation requise : `travel:write`. Corps : `{categories:[{id?, label, en?:{label}}]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "kosher", "hotel", "attraction" ] } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/I18nOverlay" } } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "UNKNOWN_CATEGORY_TYPE / TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNKNOWN_CATEGORY_TYPE / TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/kosher Lister les lieux casher `list_travel_kosher` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/KosherPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/kosher Créer un lieu casher `create_travel_kosher` Autorisation requise : `travel:write`. `id` est généré ; `organisation`/`travel` sont imposés côté serveur. Les champs image acceptent une URL http(s) (réhébergée) ou un nom de fichier. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KosherPlace" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KosherPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/kosher/{id} Obtenir un lieu casher `get_travel_kosher` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KosherPlace" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/kosher/{id} Modifier un lieu casher `update_travel_kosher` Autorisation requise : `travel:write`. Fusionne les champs assainis avec le document existant. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KosherPlace" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KosherPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/kosher/{id} Supprimer un lieu casher `delete_travel_kosher` Autorisation requise : `travel:write`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/kosher/positions Réorganiser les lieux casher `reorder_travel_kosher` Autorisation requise : `travel:write`. Corps : `{positions:[{id, position}]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/hotels Lister les hôtels `list_travel_hotels` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/HotelPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/hotels Créer un hôtel `create_travel_hotels` Autorisation requise : `travel:write`. `id` est généré ; `organisation`/`travel` sont imposés côté serveur. Les champs image acceptent une URL http(s) (réhébergée) ou un nom de fichier. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HotelPlace" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/HotelPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/hotels/{id} Obtenir un hôtel `get_travel_hotel` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/HotelPlace" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/hotels/{id} Modifier un hôtel `update_travel_hotel` Autorisation requise : `travel:write`. Fusionne les champs assainis avec le document existant. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HotelPlace" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/HotelPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/hotels/{id} Supprimer un hôtel `delete_travel_hotel` Autorisation requise : `travel:write`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/hotels/positions Réorganiser les hôtels `reorder_travel_hotels` Autorisation requise : `travel:write`. Corps : `{positions:[{id, position}]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/attractions Lister les attractions `list_travel_attractions` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AttractionPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/attractions Créer une attraction `create_travel_attractions` Autorisation requise : `travel:write`. `id` est généré ; `organisation`/`travel` sont imposés côté serveur. Les champs image acceptent une URL http(s) (réhébergée) ou un nom de fichier. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttractionPlace" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AttractionPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/attractions/{id} Obtenir une attraction `get_travel_attraction` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AttractionPlace" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/attractions/{id} Modifier une attraction `update_travel_attraction` Autorisation requise : `travel:write`. Fusionne les champs assainis avec le document existant. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttractionPlace" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AttractionPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/attractions/{id} Supprimer une attraction `delete_travel_attraction` Autorisation requise : `travel:write`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/attractions/positions Réorganiser les attractions `reorder_travel_attractions` Autorisation requise : `travel:write`. Corps : `{positions:[{id, position}]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/bookings Lister les réservations importées `list_travel_bookings` Autorisation requise : `travel:read`. Lecture seule (importées via le back-office). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BookingPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/airbnbs Lister les annonces Airbnb importées `list_travel_airbnbs` Autorisation requise : `travel:read`. Lecture seule (importées via le back-office). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AirbnbPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/journeys Lister les demandes d’annonce de voyage `list_travel_journeys` Autorisation requise : `travel:read`. Demandes entrantes de touristes associées à un contact CRM. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "seasonId", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "includeCancelled", "in": "query", "schema": { "type": "boolean" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Journey" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/sections Lister les rubriques personnalisées `list_travel_sections` Autorisation requise : `travel:read`. Chaque rubrique contient un `itemCount`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TravelSection" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections Créer une rubrique personnalisée `create_travel_sections` Autorisation requise : `travel:write`. `slug` est normalisé et rendu unique par site (dérivé de `label` s’il est omis). Les options `fields` déterminent les champs utilisés par la rubrique. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSection" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSection" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/sections/{sid} Obtenir une rubrique personnalisée `get_travel_section` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSection" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/sections/{sid} Modifier une rubrique personnalisée `update_travel_section` Autorisation requise : `travel:write`. Mise à jour partielle ; le slug est recalculé si `label`/`slug` change. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSection" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSection" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/sections/{sid} Supprimer une rubrique personnalisée (et ses lieux) `delete_travel_section` Autorisation requise : `travel:write`. Tous les lieux de la rubrique sont également supprimés. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections/positions Réorganiser les rubriques personnalisées `reorder_travel_sections` Autorisation requise : `travel:write`. Corps : `{positions:[{id, position}]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/sections/{sid}/items Lister les lieux d’une rubrique personnalisée `list_travel_sections_items` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TravelSectionItem" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections/{sid}/items Créer un lieu dans une rubrique personnalisée `create_travel_sections_items` Autorisation requise : `travel:write`. `sectionId` est imposé à partir du chemin. Les champs de lieu non activés par les options `fields` de la rubrique sont tout de même acceptés (le tiers affiche sa propre interface). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSectionItem" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSectionItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/sections/{sid}/items/{id} Obtenir un lieu d’une rubrique personnalisée `get_travel_sections_item` Autorisation requise : `travel:read`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:read", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSectionItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/sections/{sid}/items/{id} Modifier un lieu d’une rubrique personnalisée `update_travel_sections_item` Autorisation requise : `travel:write`. Mise à jour partielle. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSectionItem" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSectionItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/sections/{sid}/items/{id} Supprimer un lieu d’une rubrique personnalisée `delete_travel_sections_item` Autorisation requise : `travel:write`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections/{sid}/items/positions Réorganiser les lieux d’une rubrique personnalisée `reorder_travel_sections_items` Autorisation requise : `travel:write`. Corps : `{positions:[{id, position}]}`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "travel:write", "additional": [] } ``` #### Paramètres ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site/facades Lister les façades (sites) de l’organisation `list_site_facades` Autorisation requise : `site:read`. Liste le site principal et les sites virtuels afin de savoir quel `virtualId` transmettre aux autres opérations /site. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SiteFacade" } } } } } } } ``` ##### HTTP 401 ```json { "description": "Clé absente ou invalide" } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site Obtenir la configuration du thème du site classique `get_site` Autorisation requise : `site:read`. Renvoie la configuration normalisée du thème (apparence, menu, bannière principale, bannières, homeSections, preFooterSections, donationPage) de la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:read", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/appearance Définir le thème et les tokens de couleur/police `update_site_appearance` Autorisation requise : `site:write`. Définit le `theme` actif et/ou les `tokens` 2026 ; chaque champ fourni remplace sa valeur correspondante. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteAppearance" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site/seo Obtenir le SEO par défaut du site `get_site_seo` Autorisation requise : `site:read`. SEO par défaut de la page d’accueil et de toute page CMS publique sans SEO propre. Chaque champ est résolu indépendamment : SEO explicite de la page, puis valeur par défaut du site, puis valeur générée automatiquement existante. S’applique aux thèmes classique, Travel, mobile et campagne. Les valeurs de la langue par défaut sont à la racine ; les autres langues activées utilisent des surcharges partielles. Les champs/surcharges omis sont conservés ; null ou une chaîne vide efface une valeur individuelle (rétablit la valeur de repli). Un objet de langue null/vide supprime uniquement cette surcharge. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:read", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteSeo" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/seo Modifier le SEO par défaut du site `update_site_seo` Autorisation requise : `site:write`. SEO par défaut de la page d’accueil et de toute page CMS publique sans SEO propre. Chaque champ est résolu indépendamment : SEO explicite de la page, puis valeur par défaut du site, puis valeur générée automatiquement existante. S’applique aux thèmes classique, Travel, mobile et campagne. Les valeurs de la langue par défaut sont à la racine ; les autres langues activées utilisent des surcharges partielles. Les champs/surcharges omis sont conservés ; null ou une chaîne vide efface une valeur individuelle (rétablit la valeur de repli). Un objet de langue null/vide supprime uniquement cette surcharge. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteSeo" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteSeo" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION" } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site/donation-page Obtenir tous les paramètres de la page de don principale `get_site_donation_page` Autorisation requise : `site:read`. Renvoie tous les paramètres de la page de don principale, y compris le contenu/médias/listes de montants prédéfinis des autres langues, la cagnotte principale associée et la redirection principale /don. Fonctionne avec les thèmes classique, Travel et mobile. Également accessible sous donationPage dans GET /site. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:read", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteDonationPage" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/donation-page Modifier tous les paramètres de la page de don principale `update_site_donation_page` Autorisation requise : `site:write`. Paramètres de la page de don principale (admin « Ma page de don »), partagés par les thèmes classique, Travel et mobile. Mise à jour partielle : les champs et traductions omis sont conservés. Les tableaux de médias/montants prédéfinis remplacent le tableau fourni. Les valeurs de la langue par défaut sont à la racine ; les autres langues peuvent remplacer les cinq champs de présentation, y compris les tableaux entiers. Une cagnotte `mainCaisse` associée fournit son propre contenu/média/montants prédéfinis ; la redirection prévaut sur la page /don principale. Ne modifie pas les paramètres généraux des fournisseurs de paiement de l’organisation ni la configuration de campagne. Les champs omis dans une surcharge linguistique sont également conservés. Envoyez une langue à null ou {} pour supprimer uniquement les traductions de cette page dans cette langue, sans toucher aux autres traductions du site. Null sur un texte/une image traduits supprime cette personnalisation ; [] vide un tableau traduit. Les images de la langue principale et des autres langues sont réhébergées ; un échec d’importation annule la mise à jour. Les champs inconnus, les surcharges pour une langue désactivée et les champs de routage non traduisibles dans une surcharge sont refusés. `mainCaisse` doit appartenir à cette organisation. Utilisez GET /me pour connaître defaultLanguage/enabledLanguages. Gérez séparément les fournisseurs de paiement globaux. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteDonationPage" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteDonationPage" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND, CAISSE_NOT_FOUND ou NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/menu Définir les boutons CTA de l’en-tête `update_site_menu` Autorisation requise : `site:write`. Remplace les deux boutons d’appel à l’action de l’en-tête (envoyez l’objet complet). Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMenu" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/hero Définir les diapositives du carrousel de la bannière principale `update_site_hero` Autorisation requise : `site:write`. Remplace l’intégralité du carrousel de la bannière principale par le tableau `slides` fourni. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "slides" ], "properties": { "slides": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSlide" }, "description": "Diapositives de la bannière principale, dans l’ordre (remplace tout le carrousel)." } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/banners Définir les bannières promotionnelles `update_site_banners` Autorisation requise : `site:write`. Remplace les bannières promotionnelles par le tableau `items` fourni. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSlide" }, "description": "Bannières promotionnelles (remplace tout le contenu existant)." } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/home-sections Définir les sections de la page d’accueil `update_site_home_sections` Autorisation requise : `site:write`. Remplace la composition de la page d’accueil par le tableau `sections` fourni (l’ordre du tableau détermine l’ordre sur la page). Appelez GET /site d’abord pour conserver les sections intégrées et leurs identifiants. Une section CUSTOM_CONTENT avec props.contentType="AI" référence un aiContentBlockId — écrivez son HTML via PUT /content-blocks/{id}/content. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSection" }, "description": "Sections d’accueil dans l’ordre (remplace la composition actuelle)." } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/prefooter-sections Définir les sections avant le pied de page `update_site_prefooter_sections` Autorisation requise : `site:write`. Remplace les sections affichées avant le pied de page sur chaque page. Cible la façade indiquée par `?virtualId` (omettre = site principal). #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "site:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSection" }, "description": "Sections avant le pied de page, dans l’ordre (remplace toutes les sections existantes)." } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /mobile-config/facades Lister les façades (applications mobiles) de l’organisation `list_mobile_config_facades` Autorisation requise : `mobile_config:read`. Liste l’application principale et les applications virtuelles afin de savoir quel `virtualId` transmettre aux autres opérations /mobile-config. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MobileFacade" } } } } } } } ``` ##### HTTP 401 ```json { "description": "Clé absente ou invalide" } ``` ##### HTTP 403 ```json { "description": "AUTORISATION_INSUFFISANTE" } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /mobile-config Obtenir la configuration de l’application mobile `get_mobile_config` Autorisation requise : `mobile_config:read`. Renvoie la configuration mobile normalisée (label, active, config.*, ainsi que distribution et knownHosts en lecture seule) de la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:read", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MobileConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED" } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/meta Définir le libellé/l’état actif de la configuration `update_mobile_config_meta` Autorisation requise : `mobile_config:write`. Définit les métadonnées de cycle de vie à la racine (`label` et/ou `active`). Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileMeta" }, "example": { "label": "App Beth Habad", "active": true } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/branding Définir les couleurs d’accent de l’application `update_mobile_config_branding` Autorisation requise : `mobile_config:write`. Définit les couleurs d’accent dans l’application (principale/secondaire). Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileBranding" }, "example": { "primary": "#1D4ED8", "secondary": "#F59E0B" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/bottom-bar Définir l’apparence de la barre inférieure `update_mobile_config_bottom_bar` Autorisation requise : `mobile_config:write`. Définit l’apparence de la barre d’onglets inférieure (visible / variant / showLabels). Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileBottomBar" }, "example": { "visible": true, "variant": "fixed", "showLabels": true } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/tabs Définir les onglets de la barre inférieure `update_mobile_config_tabs` Autorisation requise : `mobile_config:write`. Remplace toute la liste d’onglets inférieure par le tableau `tabs` fourni (son ordre détermine l’affichage à l’écran). Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "tabs" ], "properties": { "tabs": { "type": "array", "items": { "$ref": "#/components/schemas/MobileTab" }, "description": "Onglets de la barre inférieure, dans l’ordre (remplace tous les onglets)." } } }, "example": { "tabs": [ { "url": "", "label": "Accueil", "icon": { "name": "home", "source": "lucide" }, "active": true }, { "url": "/don", "label": "Don", "en": { "label": "Donate" }, "icon": { "name": "heart", "source": "lucide" }, "active": true } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/header Définir l’en-tête de l’application `update_mobile_config_header` Autorisation requise : `mobile_config:write`. Définit la barre supérieure de l’application (visible / sticky / showBack / title / actions). Envoyez l’objet complet. Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileHeader" }, "example": { "visible": true, "sticky": true, "showBack": true, "title": { "mode": "SHORTNAME" }, "actions": [ { "type": "DRAWER", "icon": { "name": "menu", "source": "lucide" }, "label": "Menu" } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/onboarding Définir les écrans de bienvenue `update_mobile_config_onboarding` Autorisation requise : `mobile_config:write`. Définit le carrousel d’intégration du premier lancement (enabled / version / slides). Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileOnboarding" }, "example": { "enabled": true, "version": 1, "slides": [ { "title": "Bienvenue", "en": { "title": "Welcome" }, "description": "Découvrez notre app", "textPosition": "bottom", "overlay": "LIGHT" } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/account Définir l’exigence de connexion au compte `update_mobile_config_account` Autorisation requise : `mobile_config:write`. Définit si l’application demande à l’utilisateur de se connecter (mode NONE/OPTIONAL/REQUIRED + version). Pris en compte uniquement si l’espace de compte est disponible pour l’organisation. Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileAccount" }, "example": { "mode": "OPTIONAL", "version": 1 } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/initial-url Définir l’URL de démarrage de l’application `update_mobile_config_initial_url` Autorisation requise : `mobile_config:write`. Définit l’URL exacte ouverte par l’application au démarrage (`initialUrl`) ; une valeur vide signifie qu’elle est déduite automatiquement du domaine de l’organisation. Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileInitialUrl" }, "example": { "initialUrl": "/accueil-app" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/external-apps Définir les règles de routage des liens externes `update_mobile_config_external_apps` Autorisation requise : `mobile_config:write`. Remplace la liste des liens qui s’ouvrent nativement plutôt que dans le navigateur intégré (transmise dans `items`). Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MobileExternalApp" }, "description": "Règles de routage des liens externes (remplace toutes les règles existantes)." } } }, "example": { "items": [ { "match": "my-partner.com", "mode": "SYSTEM" } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/sections Définir les sections de l’accueil `update_mobile_config_sections` Autorisation requise : `mobile_config:write`. Remplace la composition de l’accueil mobile par le tableau `sections` fourni (son ordre détermine l’ordre à l’écran). Appelez GET /mobile-config d’abord pour conserver les sections et identifiants existants. Une section CUSTOM_CONTENT avec props.contentType="AI" référence un aiContentBlockId — écrivez son HTML via PUT /content-blocks/{id}/content. Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/MobileSection" }, "description": "Sections d’accueil dans l’ordre (remplace la composition actuelle)." } } }, "example": { "sections": [ { "type": "HERO", "label": "Hero", "props": { "slides": [ { "image": "https://example.com/hero.jpg", "title": "Bienvenue", "btn1_label": "Faire un don", "btn1_url": "/don" } ] } }, { "type": "ACTIONS_GRID", "label": "Raccourcis", "props": { "style": "ROUND", "items": [ { "icon": { "name": "heart", "source": "lucide" }, "label": "Don", "url": "/don" } ] } }, { "type": "EVENTS_PREVIEW", "label": "Événements", "props": { "title": "Nos événements", "limit": 5 } } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/prefooter-sections Définir les sections avant le pied de page `update_mobile_config_prefooter_sections` Autorisation requise : `mobile_config:write`. Remplace les sections affichées avant le pied de page sur chaque écran (transmises dans `sections`). Cible la façade indiquée par `?virtualId` (omettre = application principale). Renvoie 404 si l’application n’est pas provisionnée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### Paramètres ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (site virtuel) à cibler. Omettre = site principal. Listez les façades avec GET /site/facades." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/MobileSection" }, "description": "Sections avant le pied de page, dans l’ordre (remplace toutes les sections existantes)." } } }, "example": { "sections": [ { "type": "NEWSLETTER", "label": "Newsletter", "props": { "title": "Restez informés" } } ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND ou MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /annual-events Lister les événements annuels gérés `list_annual_events` Autorisation requise : `events:read`. Liste les projets d’événement créés via le parcours guidé de façade pour événements annuels. Inclut les événements ordinaires ponctuels et récurrents ; exclut par conception tous les parcours Shabbat/fêtes préfabriquées. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` ```json { "name": "year", "in": "query", "schema": { "type": "integer", "minimum": 2000, "maximum": 2200 } } ``` ```json { "name": "publicationStatus", "in": "query", "schema": { "type": "string", "enum": [ "CREATED", "PUBLISHED", "PUBLISHING", "PUBLISH_FAILED" ] } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnualEventProject" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 403 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "AUTORISATION_INSUFFISANTE" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /annual-events Créer et publier un événement ordinaire `create_annual_event` Autorisation requise : `events:write`. Coordonne de façon idempotente la page, le groupe, les sessions et le brouillon de formulaire/cagnotte/campagne demandé à partir d’une recette vérifiée. `idempotencyKey` est obligatoire dans le corps JSON pour REST et MCP ; l’en-tête facultatif `Idempotency-Key` peut le remplacer pour les nouvelles tentatives de transport. Une campagne reste toujours en brouillon et n’est jamais envoyée par cette opération. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:write", "additional": [] } ``` #### Paramètres ```json { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "maxLength": 200 } } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventCreateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventPublishResult" } } } } ``` ##### HTTP 400 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "INVALID_INPUT" } } } } ``` ##### HTTP 409 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "CONFLICT" } } } } ``` ##### HTTP 422 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "ERREUR_DE_VALIDATION" } } } } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "events:write" } ``` ### GET /annual-events/groups Lister les groupes d’événements ordinaires compatibles `list_annual_event_groups` Autorisation requise : `events:read`. Liste uniquement les groupes ordinaires à session unique pouvant accueillir un nouvel événement sans risque. Les groupes Shabbat, fêtes préfabriquées et sessions multiples sont exclus. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:read", "additional": [] } ``` #### Paramètres ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Nombre de résultats par page." } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Curseur opaque renvoyé par la requête précédente." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnualEventCompatibleGroup" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 403 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "AUTORISATION_INSUFFISANTE" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /annual-events/poster-analysis Préparer un brouillon d’événement à partir d’une affiche `analyze_annual_event_poster` Autorisation requise : `events:write`. Analyse une véritable image d’affiche et renvoie une recette suggérée complète. Ne publie rien ; l’appelant doit présenter le résultat pour vérification, compléter les champs incertains, puis appeler `create_annual_event`. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventPosterAnalysisRequest" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AnnualEventPosterAnalysis" } } } } } } ``` ##### HTTP 400 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "INVALID_POSTER" } } } } ``` ##### HTTP 404 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "POSTER_NOT_FOUND" } } } } ``` ##### HTTP 503 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "AI_UNAVAILABLE" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /annual-events/{id} Obtenir un événement annuel géré `get_annual_event` Autorisation requise : `events:read`. Renvoie le projet canonique, sa recette vérifiée, sa révision, son URL publique et les identifiants de ses sessions, formulaires, cagnottes et brouillons de campagne. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{3,128}$" }, "description": "Identifiant du projet d’événement annuel." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AnnualEventProject" } } } } } } ``` ##### HTTP 404 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "EVENT_NOT_FOUND" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /annual-events/{id} Modifier et republier un événement annuel géré `update_annual_event` Autorisation requise : `events:write`. Applique une mise à jour partielle à la recette enregistrée et republie les ressources gérées. Envoyez `expectedRevision` pour refuser une modification obsolète avec 409. Les tableaux fournis remplacent leur valeur précédente. Une campagne reste en brouillon et n’est jamais envoyée par cette opération. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "events:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{3,128}$" }, "description": "Identifiant du projet d’événement annuel." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "expectedRevision": { "type": "integer", "minimum": 1 }, "patch": { "$ref": "#/components/schemas/AnnualEventPatch" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "timeZone": { "type": "string" } }, "required": [ "expectedRevision", "patch" ] } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventPublishResult" } } } } ``` ##### HTTP 404 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "EVENT_NOT_FOUND" } } } } ``` ##### HTTP 409 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "REVISION_CONFLICT" } } } } ``` ##### HTTP 422 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "ERREUR_DE_VALIDATION" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /fundraising-campaigns Lister les campagnes de dons `listFundraisingCampaigns` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` ```json { "in": "query", "name": "search", "schema": { "type": "string", "maxLength": 200 } } ``` ```json { "in": "query", "name": "status", "schema": { "type": "string", "enum": [ "DRAFT", "PUBLISHED", "PAUSED", "ARCHIVED" ] } } ``` ```json { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] } } ``` ```json { "in": "query", "name": "dateStartFrom", "schema": { "type": "string", "format": "date-time" } } ``` ```json { "in": "query", "name": "dateStartTo", "schema": { "type": "string", "format": "date-time" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingCampaignRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns Créer une campagne de dons `createFundraisingCampaign` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "maxLength": 60, "pattern": "^campaign-[a-z0-9][a-z0-9-]{0,49}[a-z0-9]$" }, "type": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 1000000000, "multipleOf": 0.01 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "partnerMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "dateStart": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "dateEnd": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "donationPolicy": { "type": "string", "enum": [ "OPEN", "SCHEDULED" ] }, "bonus": { "type": "array", "items": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxItems": 30 }, "gala": { "type": "boolean" }, "ambs": { "type": "boolean" }, "stockable": { "type": "boolean" }, "tombola": { "type": "boolean", "deprecated": true, "description": "Alias historique de stockable. Conservé en lecture pour compatibilité ; utilisez stockable pour les nouvelles campagnes." }, "presentCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "ambsCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "config": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "Mise en page de présentation V2. En cas de valeur absente, vide ou non prise en charge, le design standard actuel est utilisé. Indépendante des couleurs et du paiement ; conservée pour la compatibilité future." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." } }, "required": [], "additionalProperties": false }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "url", "objectif" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/resolve/{url} Retrouver une campagne de dons par son URL `resolveFundraisingCampaign` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "url", "required": true, "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id} Obtenir une campagne de dons `getFundraisingCampaign` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id} Modifier une campagne de dons `updateFundraisingCampaign` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "maxLength": 60, "pattern": "^campaign-[a-z0-9][a-z0-9-]{0,49}[a-z0-9]$" }, "type": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 1000000000, "multipleOf": 0.01 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "partnerMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "dateStart": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "dateEnd": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "donationPolicy": { "type": "string", "enum": [ "OPEN", "SCHEDULED" ] }, "bonus": { "type": "array", "items": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxItems": 30 }, "gala": { "type": "boolean" }, "ambs": { "type": "boolean" }, "stockable": { "type": "boolean" }, "tombola": { "type": "boolean", "deprecated": true, "description": "Alias historique de stockable. Conservé en lecture pour compatibilité ; utilisez stockable pour les nouvelles campagnes." }, "presentCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "ambsCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "config": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "Mise en page de présentation V2. En cas de valeur absente, vide ou non prise en charge, le design standard actuel est utilisé. Indépendante des couleurs et du paiement ; conservée pour la compatibilité future." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." } }, "required": [], "additionalProperties": false }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/duplicate Dupliquer une campagne de dons `duplicateFundraisingCampaign` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "maxLength": 60, "pattern": "^campaign-[a-z0-9][a-z0-9-]{0,49}[a-z0-9]$" }, "type": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 1000000000, "multipleOf": 0.01 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "partnerMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "dateStart": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "dateEnd": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "donationPolicy": { "type": "string", "enum": [ "OPEN", "SCHEDULED" ] }, "bonus": { "type": "array", "items": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxItems": 30 }, "gala": { "type": "boolean" }, "ambs": { "type": "boolean" }, "stockable": { "type": "boolean" }, "tombola": { "type": "boolean", "deprecated": true, "description": "Alias historique de stockable. Conservé en lecture pour compatibilité ; utilisez stockable pour les nouvelles campagnes." }, "presentCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "ambsCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "config": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "Mise en page de présentation V2. En cas de valeur absente, vide ou non prise en charge, le design standard actuel est utilisé. Indépendante des couleurs et du paiement ; conservée pour la compatibilité future." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." } }, "required": [], "additionalProperties": false }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "url" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/publish Publier une campagne de dons `publishFundraisingCampaign` Autorisation requise : `fundraising:publish`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### POST /fundraising-campaigns/{id}/pause Mettre en pause une campagne de dons `pauseFundraisingCampaign` Autorisation requise : `fundraising:publish`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### POST /fundraising-campaigns/{id}/resume Reprendre une campagne de dons `resumeFundraisingCampaign` Autorisation requise : `fundraising:publish`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### POST /fundraising-campaigns/{id}/archive Archiver une campagne de dons `archiveFundraisingCampaign` Autorisation requise : `fundraising:publish`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### GET /fundraising-campaigns/{id}/config Obtenir la configuration de collecte de dons `getFundraisingConfiguration` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingConfig" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/config/{section} Modifier la configuration de collecte de dons `updateFundraisingConfiguration` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "section", "required": true, "schema": { "type": "string", "enum": [ "content", "appearance", "donations", "currencies", "automation" ] } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "Mise en page de présentation V2. En cas de valeur absente, vide ou non prise en charge, le design standard actuel est utilisé. Indépendante des couleurs et du paiement ; conservée pour la compatibilité future." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false, "description": "Champs partiels de la section sélectionnée : contenu, apparence, dons, devises ou automatisation. Seuls les champs de cette section sont enregistrés." } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/sections/{childId}/content Obtenir le contenu d’une section de collecte `getFundraisingSectionContent` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingSectionContentRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/sections/{childId}/content Modifier le contenu d’une section de collecte `updateFundraisingSectionContent` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "maxLength": 500000 }, "editVersion": { "type": "integer", "minimum": 0, "maximum": 1000000000 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "content", "editVersion" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingSectionContentRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/public Obtenir la version publique de la collecte `getFundraisingPublic` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "allOf": [ { "$ref": "#/components/schemas/FundraisingCampaignRead" }, { "type": "object", "properties": { "progress": { "$ref": "#/components/schemas/FundraisingProgress" }, "teams": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingteamsRead" } }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingsourcesRead" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingproductsRead" } }, "counters": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingcountersRead" } } } } ] }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/progress Obtenir la progression de la collecte `getFundraisingProgress` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingProgress" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/donors Obtenir les donateurs de la collecte `getFundraisingDonors` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingDonor" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/stats Obtenir les statistiques de la collecte `getFundraisingStats` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingProgress" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/teams Lister les équipes de collecte `listFundraisingTeams` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingteamsRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/teams Créer une équipe de collecte `createFundraisingTeam` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "description": { "type": "string", "maxLength": 50000 }, "color": { "type": "string", "maxLength": 9, "pattern": "^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$" }, "hidden": { "type": "boolean" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "param" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingteamsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/teams/{childId} Obtenir une équipe de collecte `getFundraisingTeam` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingteamsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/teams/{childId} Modifier une équipe de collecte `updateFundraisingTeam` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "description": { "type": "string", "maxLength": 50000 }, "color": { "type": "string", "maxLength": 9, "pattern": "^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$" }, "hidden": { "type": "boolean" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingteamsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/teams/{childId} Supprimer une équipe de collecte `deleteFundraisingTeam` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/sources Lister les sources de collecte `listFundraisingSources` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingsourcesRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/sources Créer une source de collecte `createFundraisingSource` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "param" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingsourcesRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/sources/{childId} Obtenir une source de collecte `getFundraisingSource` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingsourcesRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/sources/{childId} Modifier une source de collecte `updateFundraisingSource` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingsourcesRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/sources/{childId} Supprimer une source de collecte `deleteFundraisingSource` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/products Lister les produits de collecte `listFundraisingProducts` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingproductsRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/products Créer un produit de collecte `createFundraisingProduct` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "prices": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxProperties": 20 }, "stock": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "name", "montant" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingproductsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/products/{childId} Obtenir un produit de collecte `getFundraisingProduct` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingproductsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/products/{childId} Modifier un produit de collecte `updateFundraisingProduct` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "prices": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxProperties": 20 }, "stock": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingproductsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/products/{childId} Supprimer un produit de collecte `deleteFundraisingProduct` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/products/positions Réorganiser les produits de collecte `orderFundraisingProducts` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "maxLength": 36, "format": "uuid" }, "maxItems": 200 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "ids" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/counters Lister les compteurs de collecte `listFundraisingCounters` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingcountersRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/counters Créer un compteur de collecte `createFundraisingCounter` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "nb": { "type": "integer", "minimum": 0, "maximum": 1000000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingcountersRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/counters/{childId} Obtenir un compteur de collecte `getFundraisingCounter` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingcountersRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/counters/{childId} Modifier un compteur de collecte `updateFundraisingCounter` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "nb": { "type": "integer", "minimum": 0, "maximum": 1000000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Surcharge pour une langue secondaire activée. La langue par défaut utilise les champs racine ; null supprime une surcharge." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingcountersRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/counters/{childId} Supprimer un compteur de collecte `deleteFundraisingCounter` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/counters/positions Réorganiser les compteurs de collecte `orderFundraisingCounters` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "maxLength": 36, "format": "uuid" }, "maxItems": 200 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "ids" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/ambassadors Lister les ambassadeurs de collecte `listFundraisingAmbassadors` Autorisation requise : `fundraising:read`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/ambassadors Attribuer un ambassadeur de collecte `assignFundraisingAmbassador` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "teamId": { "type": "string", "maxLength": 36, "format": "uuid" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "contactId", "teamId" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/ambassadors/{childId} Retirer un ambassadeur de collecte `removeFundraisingAmbassador` Autorisation requise : `fundraising:write`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/checkouts Créer une page de paiement de collecte `createFundraisingCheckout` Autorisation requise : `fundraising:checkout`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. Crée une URL de paiement Unisoft hébergée, à durée limitée, sans encaisser. RECURRING nécessite amountBasis MONTHLY ; INSTALLMENTS nécessite amountBasis TOTAL et un total divisible par installments. Les devises VIRTUAL sont uniquement destinées à l’affichage : envoyez la devise principale. C’est la confirmation du fournisseur qui détermine l’état COMPLETED ; returnUrl ne le détermine pas. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 100000000 }, "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "mode": { "type": "string", "enum": [ "ONCE", "RECURRING", "INSTALLMENTS" ] }, "installments": { "type": "integer", "minimum": 1, "maximum": 120 }, "amountBasis": { "type": "string", "enum": [ "MONTHLY", "TOTAL" ] }, "returnUrl": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "reservationId": { "type": "string", "maxLength": 36, "format": "uuid" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "amount", "devise" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCheckoutRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### GET /fundraising-campaigns/{id}/checkouts/{childId} Obtenir une page de paiement de collecte `getFundraisingCheckout` Autorisation requise : `fundraising:checkout`. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCheckoutRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:checkout" } ``` ### POST /fundraising-campaigns/{id}/checkouts/{childId}/cancel Annuler une page de paiement de collecte `cancelFundraisingCheckout` Autorisation requise : `fundraising:checkout`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCheckoutRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### POST /fundraising-campaigns/{id}/reservations Réserver des produits de collecte `reserveFundraisingProducts` Autorisation requise : `fundraising:checkout`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 64, "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "nb": { "type": "integer", "minimum": 1, "maximum": 10000 } }, "required": [ "id", "nb" ], "additionalProperties": false }, "maxItems": 50 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "products" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### DELETE /fundraising-campaigns/{id}/reservations/{childId} Libérer des produits de collecte `releaseFundraisingProducts` Autorisation requise : `fundraising:checkout`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### GET /fundraising-campaigns/{id}/payments Lister les paiements de collecte `listFundraisingPayments` Autorisation requise : `fundraising:read`. Nécessite également `paiements:read` (les deux autorisations sont vérifiées). Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [ "paiements:read" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Paiement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/subscriptions Lister les abonnements de collecte `listFundraisingSubscriptions` Autorisation requise : `fundraising:read`. Nécessite également `abonnements:read` (les deux autorisations sont vérifiées). Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [ "abonnements:read" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Abonnement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "abonnements:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/subscriptions/{childId}/cancel Annuler un abonnement de collecte `cancelFundraisingSubscription` Autorisation requise : `fundraising:write`. Nécessite également `abonnements:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "abonnements:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": true, "idempotent": true, "warn": true }, "x-unisoft-additional-scopes": [ "abonnements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/pledges Lister les promesses de don de collecte `listFundraisingPledges` Autorisation requise : `fundraising:read`. Nécessite également `promesses:read` (les deux autorisations sont vérifiées). Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [ "promesses:read" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promesse" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/pledges Créer une promesse de don de collecte `createFundraisingPledge` Autorisation requise : `fundraising:write`. Nécessite également `promesses:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "name": { "type": "string", "maxLength": 300 }, "occasion": { "type": "string", "maxLength": 300 }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "contactId", "montant" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/pledges/{childId} Obtenir une promesse de don de collecte `getFundraisingPledge` Autorisation requise : `fundraising:read`. Nécessite également `promesses:read` (les deux autorisations sont vérifiées). Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:read", "additional": [ "promesses:read" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/pledges/{childId} Modifier une promesse de don de collecte `updateFundraisingPledge` Autorisation requise : `fundraising:write`. Nécessite également `promesses:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "name": { "type": "string", "maxLength": 300 }, "occasion": { "type": "string", "maxLength": 300 }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/pledges/{childId}/cancel Annuler une promesse de don de collecte `cancelFundraisingPledge` Autorisation requise : `fundraising:write`. Nécessite également `promesses:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/pledges/{childId}/payment-link Créer le lien de paiement d’une promesse de don de collecte `createFundraisingPledgePaymentLink` Autorisation requise : `fundraising:write`. Nécessite également `promesses:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/offline-donations Enregistrer un don de collecte hors ligne `recordFundraisingOfflineDonation` Autorisation requise : `fundraising:write`. Nécessite également `paiements:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. Enregistre des fonds déjà encaissés ; imported:true, sans émettre de reçu en double ni déclencher de prélèvement fournisseur. REST uniquement. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 100000000 }, "method": { "type": "string", "enum": [ "CB", "VIREMENT", "CHEQUE", "PRELEVEMENT", "CASH", "NATURE" ] }, "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "datetime": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "externalId": { "type": "string", "maxLength": 200 }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "amount", "method" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/manual-contributions Créer une contribution manuelle à la collecte `createFundraisingManualContribution` Autorisation requise : `fundraising:write`. Nécessite également `paiements:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "displayName": { "type": "string", "maxLength": 200 }, "comment": { "type": "string", "maxLength": 3000 }, "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "display": { "type": "boolean" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "montant" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### PATCH /fundraising-campaigns/{id}/manual-contributions/{childId} Modifier une contribution manuelle à la collecte `updateFundraisingManualContribution` Autorisation requise : `fundraising:write`. Nécessite également `paiements:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "displayName": { "type": "string", "maxLength": 200 }, "comment": { "type": "string", "maxLength": 3000 }, "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "display": { "type": "boolean" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/manual-contributions/{childId} Supprimer une contribution manuelle à la collecte `deleteFundraisingManualContribution` Autorisation requise : `fundraising:write`. Nécessite également `paiements:write` (les deux autorisations sont vérifiées). Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. `expectedRevision` est obligatoire ; `If-Match` est également accepté sur HTTP. Les anciens documents commencent à la révision 0. Une mise à jour en conflit renvoie 409. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "ETag de révision, obligatoire ici ou dans `expectedRevision` du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### PATCH /fundraising-campaigns/{id}/participations/{kind}/{childId}/display Modérer une participation à la collecte `moderateFundraisingParticipation` Autorisation requise : `fundraising:moderate`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:moderate", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "kind", "required": true, "schema": { "type": "string", "enum": [ "payment", "subscription", "pledge", "manual" ] } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:moderate" } ``` ### POST /fundraising-campaigns/{id}/visits Enregistrer une visite liée à la collecte `recordFundraisingVisit` Autorisation requise : `fundraising:checkout`. Chaque mutation nécessite une `idempotencyKey` (corps) ou un en-tête Idempotency-Key. Réutiliser une clé avec un corps différent renvoie 409. Toute opération en cours ou au résultat incertain doit être rapprochée ; ne réessayez pas un paiement avec une nouvelle clé. Montants : le montant d’un paiement/checkout est un entier en unités mineures ; les objectifs de campagne, `montant` produit, `montant` de promesse et `montant` de contribution manuelle sont en unités majeures. AMOUNT correspond en interne à l’ancien type de campagne vide. Les indicateurs de progression (appariements, promesses, engagements récurrents et supplément Gift Aid) ne représentent pas des fonds encaissés. FULL inclut le droit d’accès aux campagnes. Les autres forfaits permettant les pages nécessitent le module CAMPAGNE. Les clés API peuvent être limitées aux `fundraisingCampaignIds` ; une telle clé ne peut pas créer ni dupliquer une campagne. Les clés API privées doivent rester sur le serveur de votre site, jamais dans le JavaScript du navigateur. Les surcharges de contenu suivent les langues activées de l’organisation ; la langue par défaut est à la racine. null supprime une surcharge de langue secondaire. Téléversez d’abord les images via /uploads ; les noms de fichiers doivent appartenir à cette organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### Paramètres ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Obligatoire ici ou dans la clé idempotencyKey du corps" } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "visitorId": { "type": "string", "maxLength": 100 }, "team": { "type": "string", "maxLength": 36, "format": "uuid" }, "source": { "type": "string", "maxLength": 36, "format": "uuid" }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "visitorId" ], "additionalProperties": false } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Succès", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Requête mal formée / clé d’idempotence manquante" } ``` ##### HTTP 403 ```json { "description": "Autorisation ou droit de campagne manquant" } ``` ##### HTTP 404 ```json { "description": "Campagne ou ressource inconnue (y compris une ressource d’une autre organisation)" } ``` ##### HTTP 409 ```json { "description": "Conflit de révision, d’état du cycle de vie, de stock ou d’idempotence" } ``` ##### HTTP 422 ```json { "description": "Erreur de validation ; champ indiqué" } ``` ##### HTTP 428 ```json { "description": "expectedRevision obligatoire" } ``` ##### HTTP 500 ```json { "description": "Échec inattendu ; rapprochez toute mutation dont le résultat est incertain" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### GET /email-templates/catalog/variables Lister les variables d’email prises en charge `list_email_template_variables` Autorisation système requise : `email_template_catalog:read`. Renvoie les seules variables qu’une IA peut utiliser. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateVariableCatalogue" } } } } } } ``` ##### HTTP 403 ```json { "description": "CATALOG_SYSTEM_KEY_REQUIRED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_SYSTEM_KEY_REQUIRED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/catalog/assets Téléverser une image pour les emails du catalogue `upload_catalog_email_template_asset` Autorisation système requise : `email_template_catalog:write`. Accepte une image PNG, JPEG ou WebP en base64, valide les véritables octets de l’image et renvoie une URL HTTPS stable à utiliser dans le HTML. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogAssetInput" } } } } ``` #### Réponses ##### HTTP 201 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogAsset" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/catalog Lister les brouillons du catalogue et les modèles publiés `list_catalog_email_templates` Autorisation système requise : `email_template_catalog:read`. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### Paramètres ```json { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "DRAFT", "PUBLISHED" ] } } ``` ```json { "name": "language", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 100 } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/catalog Créer un brouillon complet du catalogue `create_catalog_email_template` Autorisation système requise : `email_template_catalog:write`. Crée ensemble le HTML et les métadonnées du catalogue, puis renvoie les résultats de validation. Le modèle reste en DRAFT jusqu’à sa publication explicite. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogCreateInput" } } } } ``` #### Réponses ##### HTTP 201 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "ERREUR_DE_VALIDATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "CATALOG_SYSTEM_KEY_REQUIRED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_SYSTEM_KEY_REQUIRED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/catalog/{id} Obtenir un modèle du catalogue et sa validation `get_catalog_email_template` Autorisation système requise : `email_template_catalog:read`. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /email-templates/catalog/{id} Modifier les métadonnées du catalogue `update_catalog_email_template` Autorisation système requise : `email_template_catalog:write`. Fait repasser le modèle à l’état DRAFT. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogUpdateInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /email-templates/catalog/{id} Supprimer un modèle du catalogue `delete_catalog_email_template` Autorisation système requise : `email_template_catalog:write`. Supprime logiquement le modèle, qu’il soit en brouillon ou publié. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### PUT /email-templates/catalog/{id}/content Remplacer le HTML du catalogue `update_catalog_email_template_content` Autorisation système requise : `email_template_catalog:write`. Fait repasser le modèle à l’état DRAFT et renvoie les résultats de validation. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogContentInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /email-templates/catalog/{id}/validate Valider un modèle du catalogue `validate_catalog_email_template` Autorisation système requise : `email_template_catalog:read`. Vérifie les métadonnées obligatoires, les variables inconnues, le lien de désinscription, le HTML non sûr et les problèmes courants de mise en page des clients de messagerie. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateValidation" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/catalog/{id}/preview-link Créer une URL d’aperçu dans le navigateur `create_catalog_email_template_preview_link` Autorisation système requise : `email_template_catalog:read`. Renvoie une URL signée et l’objet/pré-en-tête rendu, valides de 1 à 60 minutes. L’aperçu de rédaction utilise une organisation synthétique sans risque et des valeurs d’exemple pour le destinataire ; la clé système ne lit donc aucune donnée client. Fonctionne pour les modèles DRAFT et PUBLISHED, y compris les brouillons comportant des erreurs de validation ou des avertissements de compatibilité. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplatePreviewLinkInput" } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplatePreviewLink" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 503 ```json { "description": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /email-templates/catalog/{id}/publish Publier un modèle du catalogue validé `publish_catalog_email_template` Autorisation système requise : `email_template_catalog:publish`. La publication est refusée si la validation contient une erreur. En cas de réussite, la version immuable du catalogue visible par les clients est incrémentée. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:publish", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "CATALOG_VALIDATION_FAILED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_VALIDATION_FAILED" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CATALOG_CHANGED_DURING_PUBLICATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_CHANGED_DURING_PUBLICATION" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:publish", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /email-templates/catalog/{id}/unpublish Remettre un modèle du catalogue en brouillon `unpublish_catalog_email_template` Autorisation système requise : `email_template_catalog:publish`. Retire le modèle du catalogue client sans le supprimer. Cette opération globale accepte uniquement le jeton de catalogue dédié `kc_live_*`, sans organisation. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_template_catalog:publish", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:publish", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/library Parcourir les modèles d’email publiés `list_published_email_templates` Autorisation requise : `email_templates:read`. Accessible à toutes les organisations. Renvoie uniquement les modèles PUBLISHED et indique si la version actuelle a déjà été importée dans l’organisation de l’appelant. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:read", "additional": [] } ``` #### Paramètres ```json { "name": "language", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "category", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 100 } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /email-templates/library/{id} Obtenir un modèle d’email publié `get_published_email_template` Autorisation requise : `email_templates:read`. Renvoie la source publiée, y compris ses variables HTML. Utilisez l’opération de lien d’aperçu pour l’afficher avec l’identité visuelle de l’organisation actuelle. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/library/{id}/preview-link Prévisualiser un modèle publié avec ma marque `create_published_email_template_preview_link` Autorisation requise : `email_templates:read`. Renvoie une URL de navigateur signée. L’organisation cible est toujours celle de la clé API et ne peut pas être remplacée. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:read", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Corps de la requête ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "expiresInSeconds": { "type": "integer", "minimum": 60, "maximum": 3600, "default": 900 } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplatePreviewLink" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 503 ```json { "description": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /email-templates/library/{id}/import Importer un modèle publié dans mon organisation `import_published_email_template` Autorisation requise : `email_templates:write`. Crée un modèle IA autonome dans l’organisation de l’appelant. Toutes les variables `{{org.*}}` sont résolues à partir de cette organisation ; les variables du destinataire restent à résoudre au moment de l’envoi. Importer deux fois la même version publiée est idempotent. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "email_templates:write", "additional": [] } ``` #### Paramètres ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid." } ``` #### Réponses ##### HTTP 200 ```json { "description": "Déjà importé", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateImportResult" } } } } ``` ##### HTTP 201 ```json { "description": "Importé", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateImportResult" } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /wordpress/catalog Lister le contenu public associé à l’organisation connectée `list_wordpress_catalog` Autorisation requise : `wordpress:read`. Métadonnées réservées à l’éditeur authentifié. Le contenu public est disponible automatiquement. resourceAccess est public ; le champ historique de sélection contient tous les identifiants renvoyés pour les anciens plugins. Ce n’est pas une opération anonyme destinée au navigateur. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "wordpress:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "Projection publique uniquement ; jamais de données de donateur ou de soumission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "wordpress:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PUT /wordpress/selection Enregistrer les préférences de contenu historique pour les anciens plugins `update_wordpress_selection` Autorisation requise : `wordpress:publish`. La connexion nécessite également wordpress:read. Les identifiants sont revérifiés par rapport aux ressources publiques de son organisation. Les préférences enregistrées ne restreignent plus l’accès au contenu public. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "wordpress:publish", "additional": [] } ``` #### Corps de la requête ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "selection" ], "properties": { "selection": { "type": "object", "properties": { "donation": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "forms": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "events": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "caisses": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "pages": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "galleries": { "type": "array", "maxItems": 100, "items": { "type": "string" } } } } } } } } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Projection publique uniquement ; jamais de données de donateur ou de soumission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` #### OpenAPI ```json { "deprecated": true, "x-unisoft-scope": "wordpress:publish", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /wordpress/data/{kind} Lire les modules publics de l’organisation `get_wordpress_data` Autorisation requise : `wordpress:read`. L’appartenance à l’organisation et la disponibilité publique active sont vérifiées à chaque requête. Les montants sont des entiers en unités mineures, avec une devise par collection. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "wordpress:read", "additional": [] } ``` #### Paramètres ```json { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "donation", "forms", "events", "caisses", "pages", "galleries" ] } } ``` ```json { "name": "id", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "lang", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 24 } } ``` #### Réponses ##### HTTP 200 ```json { "description": "Projection publique uniquement ; jamais de données de donateur ou de soumission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 404 ```json { "description": "Ressource indisponible, inactive ou appartenant à une autre organisation" } ``` #### OpenAPI ```json { "x-unisoft-scope": "wordpress:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /wordpress/connection Déconnecter ce site WordPress `delete_wordpress_connection` Autorisation requise : `wordpress:read`. Supprime uniquement les paramètres de publication de cette clé ; révoque les jetons OAuth, mais ne révoque pas une clé d’intégration fournie manuellement. #### Authentification ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### Permissions requises ```json { "accepted": "wordpress:read", "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "Projection publique uniquement ; jamais de données de donateur ou de soumission.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "wordpress:read", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /wordpress/releases/stable Lire le manifeste signé de version du plugin `list_wordpress_releases_stable` Opération publique, indépendante de l’abonnement au compte. Construit et met automatiquement en cache la version du code déployée. Signature Ed25519 d’une charge utile JSON encodée en base64. #### Authentification ```json [] ``` #### Permissions requises ```json { "accepted": null, "additional": [] } ``` #### Réponses ##### HTTP 200 ```json { "description": "Manifeste signé", "content": { "application/json": { "schema": { "type": "object", "required": [ "signed", "signature" ], "properties": { "signed": { "type": "string" }, "signature": { "type": "string" } } } } } } ``` ##### HTTP 503 ```json { "description": "Génération de version temporairement indisponible ; réessayez plus tard" } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### Schémas ````json { "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key", "description": "Format : `ke_live_xxx`" }, "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key" } }, "schemas": { "Error": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_API_KEY" } } }, "Pagination": { "type": "object", "properties": { "nextCursor": { "type": "string", "nullable": true }, "hasMore": { "type": "boolean" }, "count": { "type": "integer" } } }, "Contact": { "type": "object", "description": "Un contact (donateur / membre) de l’organisation. Les champs d’identité sont à plat ; les sous-collections à valeurs multiples (adresses, téléphones et emails secondaires, balises, champs personnalisés, liens familiaux) sont des tableaux. Tous les champs `readOnly` sont calculés et ne sont jamais acceptés lors d’une écriture.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "UUID généré par le serveur. Utilisez-le comme `{id}` dans chaque chemin de sous-ressource." }, "firstName": { "type": "string", "description": "Prénom. Enregistré avec une majuscule initiale (« david » → « David »)." }, "lastName": { "type": "string", "description": "Nom de famille. Enregistré EN MAJUSCULES (« levy » → « LEVY »)." }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "Genre : « M » (masculin) ou « F » (féminin), null = inconnu. Déduit de la civilité lors de l’importation — jamais deviné." }, "email": { "type": "string", "description": "Email principal (en minuscules). Les emails supplémentaires se trouvent dans `secondaryEmails[]`." }, "phone": { "type": "string", "description": "Téléphone principal au format E.164 (`+33612345678`). Les numéros supplémentaires se trouvent dans `secondaryPhones[]`." }, "birthDate": { "type": "string", "format": "date", "nullable": true, "description": "Date de naissance, au format ISO `YYYY-MM-DD`." }, "hebrewFirstName": { "type": "string", "description": "Prénom hébraïque." }, "taxId": { "type": "string", "nullable": true, "description": "Identifiant national / fiscal (par ex. Teudat Zehut israélienne). Déclaratif — aucune vérification auprès d’un registre." }, "giftAid": { "type": "boolean", "description": "Indicateur d’éligibilité au Gift Aid britannique. Déclaratif." }, "address": { "type": "string", "description": "Adresse principale — ligne de rue (à plat, sans identifiant)." }, "postalCode": { "type": "string", "description": "Adresse principale — code postal." }, "city": { "type": "string", "description": "Adresse principale — ville." }, "region": { "type": "string", "description": "Adresse principale — état / région / province." }, "country": { "type": "string", "description": "Adresse principale — pays." }, "note": { "type": "string", "nullable": true, "description": "Note libre sur l’adresse principale." }, "addresses": { "type": "array", "description": "Adresses SECONDAIRES (chacune avec un UUID `id` stable — modifiables via PATCH /contacts/{id}/addresses/{addressId}). L’adresse principale est représentée à plat par les champs `address`/`postalCode`/`city` ci-dessus et ne possède AUCUN identifiant.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "label": { "type": "string", "description": "Libellé libre de l’adresse (par ex. « Bureau »)." }, "type": { "type": "string", "nullable": true, "description": "PRO | PERSO (libellé libre)." }, "address": { "type": "string", "description": "Ligne de rue." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "companyId": { "type": "string", "nullable": true, "description": "Numéro d’immatriculation de l’entreprise (pour une adresse PRO)." }, "note": { "type": "string", "nullable": true } } } }, "secondaryPhones": { "type": "array", "description": "Téléphones supplémentaires (E.164). Le numéro principal est `phone`.", "items": { "type": "object", "properties": { "phone": { "type": "string" } } } }, "secondaryEmails": { "type": "array", "description": "Emails supplémentaires. L’email principal est `email`.", "items": { "type": "object", "properties": { "email": { "type": "string" } } } }, "tags": { "type": "array", "description": "Balises de catégorie — étiquettes booléennes (en majuscules et sans accents, par ex. `DONATEUR`, `#FORM`). Ce ne sont PAS des champs personnalisés clé/valeur — voir `customFields[]`.", "items": { "type": "string" } }, "customFields": { "type": "array", "description": "Champs personnalisés typés clé/valeur. Une entrée par clé (jamais de doublon). `type` vaut uniquement TEXT/DATE/BOOL — NUMBER/SELECT sont enregistrés en TEXT. À distinguer de `tags[]`.", "items": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "key": { "type": "string" }, "type": { "type": "string", "description": "TEXT | DATE | BOOL" }, "value": { "nullable": true, "description": "Valeur enregistrée (chaîne, date ISO ou booléen)." } } } }, "familyLinks": { "type": "array", "description": "Liens familiaux. `contactId` = contact associé, `relationship` = SPOUSE/PARENT/CHILD/SIBLING/GRANDPARENT/GRANDCHILD/IN_LAW/EX/COUSIN/FRIEND. Bidirectionnels (le lien inverse se trouve sur l’autre contact).", "items": { "type": "object", "properties": { "relationship": { "type": "string", "enum": [ "SPOUSE", "PARENT", "CHILD", "SIBLING", "GRANDPARENT", "GRANDCHILD", "IN_LAW", "EX", "COUSIN", "FRIEND" ], "nullable": true }, "contactId": { "type": "string", "nullable": true } } } }, "isLocal": { "type": "boolean", "readOnly": true, "description": "Indique si le contact est un contact de proximité « local » (habite dans la zone d’action de l’organisation) ; défini automatiquement ou manuellement." }, "isLocalSource": { "type": "string", "nullable": true, "readOnly": true, "description": "Comment `isLocal` a été défini : AUTO | MANUAL | null." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Date de création." }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Date de dernière modification." } } }, "ContactCreateInput": { "type": "object", "description": "Identité d’un contact à CRÉER ou à INSÉRER/REMPLACER (UPSERT). Tous les champs sont facultatifs — un simple `phone` ou `email` suffit pour créer un contact utile. Formats : `gender` = « M » (masculin), « F » (féminin) ou null (inconnu — JAMAIS « Mr »/« Mme ») ; `phone` accepte une chaîne non normalisée (« 06 11 22 33 44 »), convertie au format E.164 ; `birthDate` au format ISO `YYYY-MM-DD` ; chaque entrée de `tags` est convertie en majuscules et sans accents (« Donateur régulier » → « DONATEUR_REGULIER »). Les `tags` sont des catégories booléennes ; `customFields` contient des champs typés clé/valeur — ne les confondez pas.", "required": [], "properties": { "firstName": { "type": "string", "description": "Prénom (enregistré avec une majuscule initiale)." }, "lastName": { "type": "string", "description": "Nom de famille (enregistré EN MAJUSCULES)." }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "« M » (masculin), « F » (féminin) ou null (inconnu). Jamais une civilité telle que « Mr »/« Mme »." }, "email": { "type": "string", "description": "Email principal. Les emails non valides sont ignorés." }, "phone": { "type": "string", "description": "Téléphone principal (n’importe quel format ; converti au format E.164). Fournissez `phoneCountry` pour les numéros locaux sans indicatif de pays." }, "phoneCountry": { "type": "string", "description": "Code pays ISO 3166-1 alpha-2 (par ex. « FR », « IL ») utilisé pour normaliser un `phone`/`phones` local sans préfixe `+`." }, "phones": { "type": "array", "items": { "type": "string" }, "description": "Téléphones supplémentaires (secondaires)." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Emails supplémentaires (secondaires)." }, "birthDate": { "type": "string", "format": "date", "description": "Date de naissance au format ISO `YYYY-MM-DD`. Lors d’un upsert, renseignée uniquement si vide (jamais remplacée)." }, "hebrewFirstName": { "type": "string", "description": "Prénom hébraïque." }, "taxId": { "type": "string", "description": "Identifiant national / fiscal (par ex. Teudat Zehut israélienne). Déclaratif." }, "giftAid": { "type": "boolean", "description": "Indicateur Gift Aid britannique. Déclaratif." }, "address": { "type": "string", "description": "Adresse postale principale. Si le contact possède déjà une adresse principale, celle-ci est ajoutée comme adresse secondaire." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "État / région / province." }, "country": { "type": "string", "description": "Pays (par défaut : « France »)." }, "note": { "type": "string", "description": "Note libre sur l’adresse principale." }, "addresses": { "type": "array", "description": "Adresses SECONDAIRES supplémentaires à ajouter.", "items": { "type": "object", "properties": { "label": { "type": "string" }, "type": { "type": "string", "description": "PRO | PERSO" }, "address": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "companyId": { "type": "string", "description": "Numéro d’immatriculation de l’entreprise (pour une adresse PRO)." }, "note": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Balises de catégorie à associer (chacune normalisée EN MAJUSCULES). À la CRÉATION, la première balise sert de catégorie initiale ; en l’absence de balise, la balise source `#API` est définie." }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/ContactFieldEntry" }, "description": "Champs personnalisés typés clé/valeur (upsert par clé). Lors de la création/importation, ils ne renseignent que les champs vides (ajout uniquement). À distinguer de `tags[]`." } } }, "ContactUpdateInput": { "type": "object", "description": "Champs d’identité à REMPLACER sur un contact existant (modification explicite — remplace la valeur enregistrée, contrairement à la création/upsert qui ne remplit que les champs vides). Les sous-collections (téléphones / emails / adresses secondaires, balises, champs personnalisés) ne sont PAS modifiées ici — utilisez les opérations dédiés aux sous-ressources. Une chaîne vide (\"\") signifie « ne pas modifier ». L’identité n’est jamais effacée. Mêmes formats que ContactCreateInput.", "required": [], "properties": { "firstName": { "type": "string", "description": "Remplace le prénom (majuscule initiale). \"\" = ne pas modifier." }, "lastName": { "type": "string", "description": "Remplace le nom de famille (majuscules). \"\" = ne pas modifier." }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "« M » (masculin), « F » (féminin) ou null (inconnu)." }, "email": { "type": "string", "description": "Remplace l’email principal (doit être valide → 400 INVALID_EMAIL)." }, "phone": { "type": "string", "description": "Remplace le téléphone principal (E.164 ; 400 INVALID_PHONE si impossible à analyser)." }, "phoneCountry": { "type": "string", "description": "Pays ISO utilisé pour normaliser un `phone` local." }, "birthDate": { "type": "string", "format": "date", "description": "Remplace la date de naissance (ISO). 400 INVALID_DATE si impossible à analyser." }, "hebrewFirstName": { "type": "string", "description": "Remplace le prénom hébraïque." }, "taxId": { "type": "string", "description": "Remplace l’identifiant national / fiscal (Teudat Zehut)." }, "giftAid": { "type": "boolean", "description": "Remplace l’indicateur Gift Aid britannique." }, "address": { "type": "string", "description": "Remplace l’adresse PRINCIPALE (rue)." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "note": { "type": "string" } } }, "ContactFieldEntry": { "type": "object", "description": "Champ personnalisé typé. À l’enregistrement, `type` est réduit à TEXT/DATE/BOOL — NUMBER/SELECT/etc. sont enregistrés comme TEXT (la valeur récupérée reste une chaîne).", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "Clé du champ (insensible à la casse ; `_` et `-` sont équivalents). Upsert par clé : écrire deux fois la même clé met à jour l’unique champ existant, sans jamais créer de doublon." }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "DATETIME", "BOOL" ], "description": "TEXT | NUMBER | DATE | DATETIME | BOOL. NUMBER/DATETIME sont enregistrés comme TEXT.", "default": "TEXT" }, "value": { "description": "Valeur du champ (chaîne / nombre / date ISO / booléen)." } } }, "ContactAddressInput": { "type": "object", "description": "Adresse à ajouter. Si le contact n’a pas d’adresse principale (ou si `main:true`), elle devient l’adresse principale ; sinon, elle est ajoutée comme adresse secondaire après dédoublonnage.", "required": [ "address" ], "properties": { "main": { "type": "boolean", "description": "Définir cette adresse comme adresse PRINCIPALE (remplace celle à plat)." }, "label": { "type": "string", "description": "Libellé libre (par ex. « Bureau »)." }, "type": { "type": "string", "description": "PRO | PERSO." }, "address": { "type": "string", "description": "Adresse (rue), obligatoire." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "État / région / province." }, "country": { "type": "string", "description": "Pays (par défaut : « France »)." }, "companyId": { "type": "string", "description": "Numéro d’immatriculation de l’entreprise (pour une adresse PRO)." }, "note": { "type": "string" } } }, "ContactAddressPatchInput": { "type": "object", "description": "Champs autorisés à fusionner dans une adresse SECONDAIRE (ciblée par son UUID `addressId`). Seuls les champs fournis sont modifiés. L’adresse PRINCIPALE n’a pas d’identifiant et ne peut pas être modifiée ici (utilisez PATCH /contacts/{id} ou POST /contacts/{id}/addresses avec main:true).", "properties": { "label": { "type": "string" }, "type": { "type": "string", "description": "PRO | PERSO." }, "address": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "companyId": { "type": "string" }, "note": { "type": "string" } } }, "ContactPhoneInput": { "type": "object", "description": "Téléphone SECONDAIRE à ajouter (après dédoublonnage). Le téléphone principal se définit via POST/PATCH /contacts.", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "Téléphone (n’importe quel format ; normalisé en E.164 ; 400 INVALID_PHONE si impossible à analyser)." }, "phoneCountry": { "type": "string", "description": "Code pays ISO utilisé pour normaliser un numéro local." } } }, "ContactEmailInput": { "type": "object", "description": "Email SECONDAIRE à ajouter (après dédoublonnage). L’email principal se définit via POST/PATCH /contacts.", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "Email (en minuscules ; 400 INVALID_EMAIL s’il est invalide)." } } }, "ContactTagsInput": { "type": "object", "description": "Une ou plusieurs catégories à associer (idempotent — ajouter à nouveau une balise ne fait rien). Chacune est normalisée (majuscules, sans accents, espaces remplacés par `_`). Les catégories système (#FORM/#PAIEMENT/#ABONNEMENT/#ACCOUNT/codes de devise) sont également autorisées. Une balise est une étiquette booléenne — PAS un champ personnalisé clé/valeur (voir ContactCustomFieldsInput).", "required": [ "tags" ], "properties": { "tags": { "type": "array", "items": { "type": "string" }, "description": "Balises, par ex. [\"Donateur\", \"Séder night\"] → enregistrées DONATEUR, SEDER_NIGHT." } } }, "ContactCustomFieldsInput": { "type": "object", "description": "Champs personnalisés typés clé/valeur à mettre à jour par clé. `override` (true par défaut ici — modification explicite) remplace la valeur enregistrée ; définissez-le à false pour ne remplir que les champs vides. `type` est réduit à TEXT/DATE/BOOL (NUMBER/DATETIME sont enregistrés comme TEXT). À distinguer des catégories.", "required": [ "customFields" ], "properties": { "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/ContactFieldEntry" }, "description": "Champs à définir (upsert par clé, sans doublons)." }, "override": { "type": "boolean", "description": "true (par défaut) remplace une valeur existante ; false ne remplit que les champs vides.", "default": true } } }, "ContactFamilyLinkInput": { "type": "object", "description": "Lien familial bidirectionnel entre le contact et `relatedContactId`. Le lien inverse est ajouté automatiquement (PARENT↔CHILD et GRANDPARENT↔GRANDCHILD sont asymétriques ; les autres types sont symétriques). `relatedContactId` DOIT appartenir à la même organisation (sinon 404).", "required": [ "relationship", "relatedContactId" ], "properties": { "relationship": { "type": "string", "enum": [ "SPOUSE", "PARENT", "CHILD", "SIBLING", "GRANDPARENT", "GRANDCHILD", "IN_LAW", "EX", "COUSIN", "FRIEND" ], "description": "Lien DE ce contact VERS `relatedContactId` : SPOUSE, PARENT (ce contact est le parent → lien inverse CHILD), CHILD, SIBLING, GRANDPARENT (→ lien inverse GRANDCHILD), GRANDCHILD, IN_LAW, EX, COUSIN, FRIEND." }, "relatedContactId": { "type": "string", "format": "uuid", "description": "Identifiant de l’autre contact (doit appartenir à l’organisation)." } } }, "ContactInteraction": { "type": "object", "description": "Interaction consignée avec le contact (appel, visite, note). Projection en lecture d’un document `contact_activity`.", "properties": { "id": { "type": "string", "readOnly": true }, "type": { "type": "string", "description": "Type d’interaction, par ex. « Appel », « Visite »." }, "content": { "type": "string", "description": "Notes en texte libre." }, "actions": { "type": "array", "items": { "type": "string" }, "description": "Balises textuelles facultatives décrivant ce qui a été fait." }, "author": { "type": "string", "nullable": true, "readOnly": true, "description": "Nom du membre du personnel auteur lorsque l’entrée vient de l’admin/copilote ; null pour les entrées créées via l’API." }, "datetime": { "type": "string", "format": "date-time", "readOnly": true } } }, "ContactInteractionInput": { "type": "object", "description": "Nouvelle interaction à consigner pour le contact. Utilisez-la pour enregistrer un appel/une visite/une note depuis une automatisation. Pour rester cohérent, réutilisez un `type` de GET /contacts/{id}/interactions/types au lieu d’inventer un nouveau libellé à chaque fois.", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type d’interaction (libellé libre), par ex. « Appel », « Visite », « Rencontre »." }, "content": { "type": "string", "description": "Notes libres sur l’interaction." }, "actions": { "type": "array", "items": { "type": "string" }, "description": "Balises textuelles facultatives, par ex. [« Tefiline », « Discussion »]." } } }, "ContactChildInput": { "type": "object", "description": "Enfant en bas âge à rattacher au contact (et à son éventuel conjoint SPOUSE détecté) comme parent. Dédoublonnage par prénom parmi les enfants des parents : un enfant existant est réutilisé (created:false), sinon un nouveau contact enfant est créé sans téléphone ni email. Un lien PARENT↔CHILD est créé automatiquement.", "required": [ "firstName" ], "properties": { "firstName": { "type": "string", "description": "Prénom de l’enfant (utilisé pour le dédoublonnage)." }, "lastName": { "type": "string", "description": "Nom de famille de l’enfant (en majuscules)." }, "birthDate": { "type": "string", "format": "date", "description": "Date de naissance (ISO)." } } }, "ContactDocument": { "type": "object", "description": "Fichier joint au contact (reçu, scan d’une pièce d’identité, mandat signé…). Projection en lecture d’un sous-document `contact.docs[]`.", "properties": { "id": { "type": "string", "readOnly": true, "description": "Identifiant du document (UUID) — transmettez-le à DELETE /contacts/{id}/documents/{docId}." }, "name": { "type": "string", "nullable": true, "description": "Libellé lisible (par défaut, le nom de fichier si aucun n’a été fourni)." }, "filename": { "type": "string", "nullable": true, "readOnly": true, "description": "Nom du fichier hébergé (md5.ext). Réutilisable pour joindre le MÊME fichier ailleurs sans le téléverser à nouveau." }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL absolue de téléchargement du fichier." }, "uploadedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } } }, "ContactDocumentInput": { "type": "object", "description": "Joindre un document au contact. Fournissez EXACTEMENT UN de ces éléments : `filename` (fichier déjà hébergé via POST /uploads/pdf|image) ou `url` (lien http(s), réhébergé côté serveur — image/PDF uniquement, parcours MCP/IA). Images et PDF uniquement (un document de contact est un scan, pas une vidéo). Parcours habituel : « téléverser d’abord, joindre ensuite » : POST /uploads/pdf → récupérer son `filename` → effectuer POST ici.", "properties": { "filename": { "type": "string", "description": "Nom du fichier hébergé renvoyé par POST /uploads/pdf ou POST /uploads/image (md5.ext). Il doit appartenir à cette organisation." }, "url": { "type": "string", "description": "URL http(s) publique d’une image ou d’un PDF à télécharger et héberger. Utilisez-la depuis un agent MCP/IA qui ne peut pas transmettre un flux binaire." }, "name": { "type": "string", "description": "Libellé facultatif du document (par défaut, le nom de fichier)." } } }, "ContactNormalizeInput": { "type": "object", "description": "Lignes de colonnes brutes (issues d’Excel/CSV non nettoyés) à normaliser colonne par colonne. Opération PURE — aucune base de données ni donnée d’organisation n’est modifiée. À utiliser EN PREMIER lors de l’import d’un tableur : nettoie téléphone→E.164 (+ pays détecté), email, birthDate→ISO et civilité→gender « M »/« F », et signale les `issues` de chaque ligne.", "required": [ "rows" ], "properties": { "rows": { "type": "array", "description": "Chaque objet contient les valeurs brutes des cellules d’une ligne du tableur.", "items": { "type": "object", "properties": { "phone": { "type": "string", "description": "Téléphone brut, par ex. \"06 12 34 56 78\"." }, "email": { "type": "string", "description": "Email brut, par ex. \"David.Levy@GMAIL.com \"." }, "birthDate": { "type": "string", "description": "Date de naissance brute, par ex. \"15/03/1990\" (JJ/MM/AAAA par défaut)." }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "gender": { "type": "string", "description": "Civilité/genre brut, par ex. \"Mme\", \"Mr\", \"מר\", \"M\", \"F\" → genre \"M\"/\"F\"." }, "category": { "type": "string", "description": "Balise de catégorie brute, par ex. \"Séder night\" → SEDER_NIGHT." } } } }, "defaultPhoneCountry": { "type": "string", "description": "Pays ISO 3166-1 alpha-2 (par ex. \"FR\") pour normaliser les téléphones locaux sans indicatif de pays. Par défaut : \"ZZ\" (aucun)." }, "dateFormat": { "type": "string", "description": "Indication pour les dates ambiguës (par ex. \"M/D/YYYY\" pour les fichiers américains). Les dates sont analysées avec un analyseur de dates, JAMAIS avec new Date(). Jour en premier (JJ/MM/AAAA) par défaut." } } }, "ContactLookupInput": { "type": "object", "description": "Dédoublonnage par lot — pour chaque élément, rechercher le contact correspondant de l’organisation SANS rien écrire. À utiliser après la normalisation et avant l’import pour repérer les lignes déjà présentes (matchedContactId).", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "description": "Téléphone à faire correspondre (normalisé en E.164 avant la recherche)." }, "email": { "type": "string", "description": "Email à faire correspondre (converti en minuscules avant la recherche)." } } } }, "defaultPhoneCountry": { "type": "string", "description": "Pays ISO utilisé pour normaliser les téléphones locaux. Par défaut : \"ZZ\"." } } }, "ContactImportInput": { "type": "object", "description": "Upsert en masse de 500 contacts maximum (500+ → 400 IMPORT_TOO_LARGE ; répartir sur plusieurs pages). Définissez `dryRun:true` pour obtenir le PLAN détaillé par ligne (action + problèmes), SANS rien enregistrer. Chaque ligne est normalisée et validée comme avec create_contact ; toute ligne comportant une erreur bloquante est ignorée (action:\"error\"). Appelez d’abord get_contact_import_schema pour connaître les clés de champs importables et leurs alias.", "required": [ "contacts" ], "properties": { "contacts": { "type": "array", "description": "Lignes à importer (≤ 500). Chaque ligne accepte les mêmes champs d’identité publics que ContactCreateInput (firstName/lastName/gender/email/phone/birthDate/tags/customFields/address…), ainsi qu’un `__row` facultatif (numéro de ligne source du tableur, renvoyé dans le rapport).", "items": { "allOf": [ { "$ref": "#/components/schemas/ContactCreateInput" }, { "type": "object", "properties": { "__row": { "description": "Numéro d’origine de la ligne du tableur, renvoyé dans `report.lines[].row`." } } } ] } }, "options": { "type": "object", "description": "Options d’importation.", "properties": { "dedupStrategy": { "type": "string", "enum": [ "skip", "update", "create" ], "description": "En cas de correspondance : ignorer (ne rien modifier), mettre à jour (ne remplir que les champs vides, par défaut) ou créer (toujours insérer un nouveau document).", "default": "update" }, "applyTags": { "type": "array", "items": { "type": "string" }, "description": "Balises de catégorie ajoutées à CHAQUE contact importé (normalisées EN MAJUSCULES)." }, "defaultPhoneCountry": { "type": "string", "description": "Pays ISO utilisé pour normaliser les téléphones locaux. Par défaut : \"ZZ\"." }, "dateFormat": { "type": "string", "description": "Indication pour les dates ambiguës (par ex. \"M/D/YYYY\")." } } }, "dryRun": { "type": "boolean", "description": "true = validation et planification uniquement, AUCUNE écriture. Les compteurs sont des PROJECTIONS ; `report.lines` indique l’action prévue pour chaque ligne.", "default": false } } }, "ContactImportSchema": { "type": "object", "description": "Guide d’importation auto-descriptif : catalogue des champs importables (chacun avec ses alias permettant de faire correspondre les colonnes du tableur) et options d’importation disponibles. Appelez-le EN PREMIER, associez vos colonnes à ces clés de champ, puis exécutez : normalisation → recherche des correspondances → import dryRun → import.", "properties": { "success": { "type": "boolean" }, "fields": { "type": "array", "description": "Chaque champ public importable.", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Clé du champ public à utiliser dans les lignes de normalisation/import (par ex. \"firstName\", \"phone\", \"tags\")." }, "label": { "type": "string", "description": "Libellé destiné à l’utilisateur." }, "type": { "type": "string", "description": "string | enum | date | boolean | object[]." }, "kind": { "type": "string", "enum": [ "identity", "address", "contact", "tag", "customField" ], "description": "Partie du contact alimentée par ce champ." }, "multi": { "type": "boolean", "description": "Indique si le champ accepte plusieurs valeurs (par ex. tags, téléphones secondaires)." }, "example": { "description": "Valeur d’exemple." }, "description": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" }, "description": "En-têtes de colonnes courants des tableurs FR/EN correspondant à ce champ — utilisez-les pour associer automatiquement vos colonnes." } } } }, "options": { "type": "object", "description": "Options d’importation (dedupStrategy, defaultPhoneCountry, dateFormat, requireContact, applyTags), avec leurs valeurs autorisées et valeurs par défaut ; elles reprennent l’étape d’import de la page ImportPage de l’admin.", "additionalProperties": true } } }, "ImportResult": { "type": "object", "description": "Résultat de l’importation. Même structure pour une simulation et un import réel : en mode simulation, les compteurs sont des PROJECTIONS et rien n’est enregistré ; `report.lines` est toujours présent (plan détaillé par ligne).", "properties": { "success": { "type": "boolean" }, "report": { "type": "object", "properties": { "created": { "type": "integer", "description": "Contacts créés (projection en mode simulation)." }, "updated": { "type": "integer", "description": "Contacts mis à jour (projection en mode simulation)." }, "skipped": { "type": "integer", "description": "Lignes ignorées (correspondance trouvée + dedupStrategy skip)." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "row": { "description": "__row ou index." }, "reason": { "description": "Problèmes bloquants de cette ligne." } } } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "row": {}, "reason": { "type": "string" } } } }, "lines": { "type": "array", "description": "Une entrée par ligne d’entrée (simulation ET import réel).", "items": { "type": "object", "properties": { "row": { "description": "__row (si fourni) ou index à partir de 0." }, "action": { "type": "string", "enum": [ "create", "update", "skip", "error" ], "description": "Action prévue/effectuée. \"error\" = problème bloquant → aucune écriture." }, "matchedContactId": { "type": "string", "nullable": true, "description": "Contact existant détecté lors du dédoublonnage (null = nouveau)." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Champ PUBLIC concerné par le problème (par ex. \"phone\", \"email\", \"birthDate\")." }, "reason": { "type": "string", "description": "MISSING_IDENTITY | INVALID_PHONE | INVALID_EMAIL | INVALID_DATE | INVALID_BOOL | DUPLICATE_IN_BATCH | UNKNOWN_RELATIONSHIP." }, "severity": { "type": "string", "enum": [ "error", "warning" ], "description": "error bloque l’écriture ; warning ne la bloque pas." } } } } } } } } } } }, "NormalizeResult": { "type": "object", "description": "Résultat de normalisation pour chaque ligne. Consultez `valid`/`country` pour chaque colonne afin de déterminer les corrections à apporter avant l’importation.", "properties": { "success": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "phone": { "type": "object", "properties": { "input": { "type": "string" }, "e164": { "type": "string", "nullable": true }, "national": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "valid": { "type": "boolean" } } }, "email": { "type": "object", "properties": { "input": { "type": "string" }, "value": { "type": "string", "nullable": true }, "valid": { "type": "boolean" } } }, "birthDate": { "type": "object", "properties": { "input": { "type": "string" }, "value": { "type": "string", "nullable": true, "description": "Date ISO." }, "valid": { "type": "boolean" } } }, "lastName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "Déduit de la colonne de civilité/genre brute. null si non reconnu." }, "civilityMatched": { "type": "boolean", "description": "Indique si la chaîne de civilité/genre brute a été reconnue." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Balises de catégorie normalisées et déduites de la ligne." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "severity": { "type": "string" } } } } } } } } }, "LookupResult": { "type": "object", "description": "Résultat de la recherche groupée. Chaque élément indique le contact correspondant éventuel, sans aucune écriture.", "properties": { "success": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "matchedContactId": { "type": "string", "nullable": true }, "matchedOn": { "type": "string", "nullable": true, "description": "\"phone\" ou \"email\"." }, "matchedName": { "type": "string", "nullable": true } } } }, "summary": { "type": "object", "properties": { "matched": { "type": "integer" }, "unmatched": { "type": "integer" } } } } }, "Paiement": { "type": "object", "description": "Un paiement (don, cotisation, paiement de formulaire, etc.). Les champs supplémentaires dépendent du fournisseur et du type de paiement.", "properties": { "externalRef": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S", "example": "commande-1234", "description": "Référence facultative dans votre système. Non vide, enregistrée telle quelle ; correspondance exacte sensible à la casse. Non unique et ne constitue PAS une clé d’idempotence. À distinguer de externalId (dédoublonnage à l’import). Renvoyée lors de la lecture des paiements et dans les webhooks de paiement si elle est fournie. Héritée par les paiements récurrents." }, "externalMetadata": { "type": "object", "maxProperties": 50, "additionalProperties": { "type": "string", "maxLength": 500 }, "example": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "description": "Carte facultative de chaînes clé-valeur gérée par l’appelant. Jusqu’à 50 clés (1–64 caractères chacune), valeurs de 500 caractères maximum. Les clés ne peuvent contenir . ou $, ni le caractère NUL, et ne peuvent être égales à __proto__, prototype ou constructor. Les valeurs null, tableaux, objets imbriqués et valeurs non textuelles sont refusés. Enregistrée telle quelle et renvoyée lors de la lecture des paiements et dans les webhooks ; héritée par les paiements récurrents. Distincte des métadonnées du fournisseur ; évitez d’y placer des secrets. Aucun de ces champs n’est obligatoire pour les paiements historiques." }, "name": { "type": "string", "nullable": true }, "typeId": { "type": "string", "nullable": true }, "method": { "type": "string" }, "refund": { "type": "object", "description": "Présent lorsqu’un remboursement a été demandé ; détails dépendant du fournisseur. Un remboursement confirmé a l’état SUCCEEDED.", "properties": { "state": { "type": "string" }, "reason": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "organisation": { "type": "string" }, "state": { "type": "string", "enum": [ "PENDING", "COMPLETED", "FAILED", "REFUNDED", "REFUND_PENDING", "CANCELED" ] }, "type": { "type": "string", "enum": [ "GENERAL", "SERVICE", "CAISSE", "DETTE", "FORM", "CAMPAGNE" ] }, "platform": { "type": "string" }, "amount": { "type": "integer", "description": "Montant en unités mineures (centimes)" }, "devise": { "type": "string", "example": "EUR", "description": "Code de devise" }, "contact": { "type": "string", "nullable": true, "description": "Identifiant du contact, lorsqu’il est identifié (pas un objet contact imbriqué)." }, "info": { "$ref": "#/components/schemas/PaiementInfo" }, "datetime": { "type": "string", "format": "date-time" } } }, "PaiementInfo": { "type": "object", "nullable": true, "description": "Instantané de l’identité du donateur enregistrée sur le paiement (qui a donné). **Entièrement facultatif** — envoyez `null`, `{}` ou omettez-le pour un donateur anonyme/inconnu ; chaque sous-champ est également facultatif.\n\nRègles d’enregistrement : si AU MOINS un champ est renseigné, l’objet est enregistré au complet (les autres champs deviennent des chaînes vides, jamais null) ; si TOUS les champs sont vides, il est enregistré comme `null`, ce qui signifie « aucun contact donateur » et empêche l’envoi du reçu par EMAIL (le document du reçu est tout de même produit). `email` est l’adresse à laquelle le reçu est envoyé — sans elle, le donateur ne reçoit aucun email.\n\nUn seul cas est refusé (400 INVALID_INFO) : l’envoi d’une valeur qui n’est pas un objet, par ex. une chaîne ou un tableau. Cela indique toujours une erreur d’intégration (chaîne JSON non analysée), jamais un véritable donateur.", "properties": { "nom": { "type": "string", "description": "Nom de famille." }, "prenom": { "type": "string", "description": "Prénom." }, "email": { "type": "string", "description": "Adresse email à laquelle le reçu du paiement est envoyé." }, "tel": { "type": "string", "description": "Numéro de téléphone (format E.164 recommandé)." } } }, "PaiementFacturation": { "type": "object", "nullable": true, "description": "Identité de facturation/fiscale IMPRIMÉE SUR LE REÇU et le reçu fiscal (cerfa). **Entièrement facultative** — envoyez `null`, `{}` ou omettez-la ; chaque champ sera enregistré comme une chaîne vide (jamais null), ce qui permet de générer le reçu, mais celui-ci sera imprimé sans adresse. Chaque sous-champ est également facultatif. Renseignez-la TOUJOURS lorsque le don ouvre droit à un reçu fiscal, sans quoi le document sera vierge et inutilisable par le donateur.\n\n`perso` est le discriminant : `true` (par défaut) = particulier, le reçu est établi au nom de `nom` + `prenom` ; `false` = entreprise, le reçu est établi au nom de `raison` — fournissez TOUJOURS `raison` avec `perso:false`, sinon le reçu de l’entreprise portera un nom vide (accepté, mais inutilisable par le donateur). Lorsque `perso` est true et que `nom`/`prenom` sont omis, ils sont copiés depuis `info` si présents.\n\nDeux cas sont refusés (400 INVALID_FACTURATION) ; ils indiquent toujours une erreur d’intégration, pas un véritable don : envoyer une valeur qui n’est pas un objet (une chaîne ou un tableau au lieu du bloc), ou envoyer une valeur non booléenne pour `perso` (par ex. `1`, `0` ou `\"yes\"` — auparavant ces valeurs étaient interprétées silencieusement comme `true`, émettant un reçu de particulier pour une entreprise). Les champs texte fournis sous forme booléenne sont traités comme vides, de sorte que le mot \"false\" ne peut jamais être imprimé sur un reçu ; les nombres sont acceptés et convertis (`postal: 75001` → `\"75001\"`).", "properties": { "perso": { "type": "boolean", "default": true, "description": "true = particulier (nom/prenom), false = entreprise (raison/siren). Valeur par défaut : true." }, "nom": { "type": "string", "description": "Nom de famille imprimé sur le reçu (particulier)." }, "prenom": { "type": "string", "description": "Prénom imprimé sur le reçu (particulier)." }, "civilite": { "type": "string", "description": "Civilité (M., Mme…) imprimée sur le reçu fiscal." }, "raison": { "type": "string", "description": "Raison sociale. OBLIGATOIRE si perso est false — c’est le seul nom imprimé sur un reçu d’entreprise." }, "siren": { "type": "string", "description": "Numéro d’immatriculation de l’entreprise (SIREN), imprimé à côté de sa raison sociale." }, "adresse": { "type": "string", "description": "Adresse (rue) imprimée sur le reçu et synchronisée avec le contact CRM." }, "postal": { "type": "string", "description": "Code postal." }, "ville": { "type": "string", "description": "Ville." }, "etat": { "type": "string", "description": "État / province. Imprimé sur le format de reçu canadien (CA) et synchronisé avec le CRM." }, "pays": { "type": "string", "description": "Nom du pays. Utilisé par certains fournisseurs de paiement pour déterminer le code pays ISO." }, "social_id": { "type": "string", "description": "Identifiant national (par ex. Teoudat Zehout) — utilisé par les plateformes de reçus israéliennes et synchronisé avec le contact CRM." }, "giftAid": { "type": "boolean", "description": "Royaume-Uni uniquement : le donateur a accepté le Gift Aid. Active l’indicateur Gift Aid sur le contact CRM pour permettre à l’organisme de récupérer l’allègement fiscal. Omettez ce champ pour les dons hors Royaume-Uni." } } }, "PaiementImportInput": { "type": "object", "description": "Don déjà encaissé à enregistrer comme paiement HISTORIQUE/comptable (chèque, virement, espèces, ancien logiciel ou autre plateforme). Il est enregistré avec `imported:true` et `state:\"COMPLETED\"` (forcés côté serveur) : il alimente les statistiques, compteurs de campagne, CRM et conversions de devise, mais aucun reçu/cerfa n’est émis de nouveau — le donateur l’a déjà reçu lors de l’encaissement. Utilisez cette opération pour migrer des paiements historiques ou consigner un don effectué hors plateforme ; utilisez plutôt `POST /paiements` pour qu’un donateur paie en ligne maintenant.", "required": [ "method" ], "properties": { "externalRef": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S", "example": "commande-1234", "description": "Référence facultative dans votre système. Non vide, enregistrée telle quelle ; correspondance exacte sensible à la casse. Non unique et ne constitue PAS une clé d’idempotence. À distinguer de externalId (dédoublonnage à l’import). Renvoyée lors de la lecture des paiements et dans les webhooks de paiement si elle est fournie. Héritée par les paiements récurrents." }, "externalMetadata": { "type": "object", "maxProperties": 50, "additionalProperties": { "type": "string", "maxLength": 500 }, "example": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "description": "Carte facultative de chaînes clé-valeur gérée par l’appelant. Jusqu’à 50 clés (1–64 caractères chacune), valeurs de 500 caractères maximum. Les clés ne peuvent contenir . ou $, ni le caractère NUL, et ne peuvent être égales à __proto__, prototype ou constructor. Les valeurs null, tableaux, objets imbriqués et valeurs non textuelles sont refusés. Enregistrée telle quelle et renvoyée lors de la lecture des paiements et dans les webhooks ; héritée par les paiements récurrents. Distincte des métadonnées du fournisseur ; évitez d’y placer des secrets. Aucun de ces champs n’est obligatoire pour les paiements historiques." }, "amount": { "type": "integer", "description": "Montant en unités mineures (centimes), par ex. 1500 = 15 €. Fournissez CE champ ou `montant` (pas les deux — `amount` est prioritaire). Doit être > 0." }, "montant": { "type": "number", "description": "Montant en unités majeures de la devise, par ex. 50 = 50 € (comme le saisirait une personne). Converti en centimes côté serveur. Fournissez CE champ ou `amount`." }, "method": { "type": "string", "enum": [ "CB", "VIREMENT", "CHEQUE", "PRELEVEMENT", "CASH", "NATURE" ], "description": "Moyen de paiement. CB = carte/en ligne, VIREMENT = virement, CHEQUE = chèque, PRELEVEMENT = prélèvement bancaire, CASH = espèces, NATURE = don en nature. Les alias courants (wire/check/cash…) sont acceptés et normalisés." }, "assoc": { "type": "string", "default": "MAIN", "description": "Association de l’organisation à laquelle ce don est rattaché — elle DÉTERMINE la devise et le reçu. Valeur par défaut : \"MAIN\". Consultez GET /associations pour les valeurs valides. `devise` en est toujours dérivée (ne peut pas être remplacée)." }, "contactId": { "type": "string", "description": "Identifiant facultatif d’un contact CRM (de CETTE organisation) auquel rattacher le don. Aucun contact n’est créé implicitement — fournissez un identifiant existant ou omettez ce champ." }, "type": { "type": "string", "enum": [ "GENERAL", "CAMPAGNE", "DETTE", "CAISSE", "FORM" ], "default": "GENERAL", "description": "Type de rattachement. GENERAL (par défaut) = don simple. Sinon, rattachez à une entité de l’organisation via `typeId` : CAMPAGNE (alimente son compteur), DETTE (promesse de don), CAISSE, FORM (soumission). Le rattachement ne modifie PAS la devise (`assoc` la détermine)." }, "typeId": { "type": "string", "description": "Identifiant de l’entité cible lorsque `type` ≠ GENERAL (campagne / dette / cagnotte / identifiant forms_submit). Doit appartenir à votre organisation." }, "info": { "$ref": "#/components/schemas/PaiementInfo" }, "facturation": { "$ref": "#/components/schemas/PaiementFacturation" }, "commentaire": { "type": "string", "description": "Note en texte libre conservée sur le paiement." }, "datetime": { "type": "string", "format": "date-time", "description": "Facultatif. Date RÉELLE d’encaissement du don, au format ISO 8601 (\"2024-01-15\" ou \"2024-01-15T10:30:00Z\") ; par défaut, la date actuelle si omise. À renseigner TOUJOURS lors d’une migration d’historique : cette date détermine l’ANNÉE FISCALE du reçu et sa séquence de numérotation ; une date erronée émet le reçu pour la mauvaise année. Si elle est fournie, elle doit être valide et ne pas être dans le futur — une valeur illisible (par ex. \"15/01/2024\", ambiguë, ou du texte libre) est refusée avec 400 INVALID_DATETIME au lieu d’être remplacée silencieusement par la date du jour ; une date future est refusée avec 400 DATETIME_IN_FUTURE (les dates jusqu’à 24h dans le futur sont tolérées pour compenser le décalage d’horloge du client)." }, "source": { "type": "string", "default": "API_IMPORT", "description": "Libellé identifiant la provenance du paiement (par ex. \"HELLOASSO\", \"MY_OLD_SOFTWARE\"). Converti en majuscules. Valeur par défaut : \"API_IMPORT\"." }, "externalId": { "type": "string", "description": "Votre référence stable pour ce paiement dans le système source. Lorsqu’elle est fournie, l’import est IDEMPOTENT : renvoyer le même externalId met à jour le même paiement au lieu d’en créer un doublon (réessai ou relance de migration sans risque). Sans cette référence, chaque appel crée un nouveau paiement." } } }, "FormSubmit": { "type": "object", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "form": { "type": "string", "description": "Identifiant du formulaire" }, "state": { "type": "string" }, "data": { "type": "object" }, "total": { "type": "number", "description": "Montant total attendu pour l’inscription, en unités majeures de la devise." }, "devise": { "type": "string", "description": "Code de devise." }, "paye": { "type": "number", "readOnly": true, "description": "Montant réellement payé (somme des paiements COMPLETED), en unités majeures." }, "reste": { "type": "number", "readOnly": true, "description": "Solde restant (max(0, total - paye)), en unités majeures." }, "paiements": { "type": "array", "readOnly": true, "description": "Paiements COMPLETED de cette soumission (montants en unités majeures). Disponible uniquement sur GET /forms-submit/{id}.", "items": { "type": "object", "properties": { "amount": { "type": "number" }, "method": { "type": "string", "nullable": true }, "datetime": { "type": "string", "format": "date-time" } } } }, "datetime": { "type": "string", "format": "date-time" } } }, "Abonnement": { "type": "object", "description": "Un abonnement (don récurrent)", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "state": { "type": "string" }, "active": { "type": "boolean" }, "amount": { "type": "integer", "description": "Montant en unités mineures (centimes)" }, "devise": { "type": "string", "description": "Code de devise" }, "contact": { "type": "string", "description": "Identifiant du contact" }, "datetime": { "type": "string", "format": "date-time" } } }, "Promesse": { "type": "object", "description": "Promesse de don : montant qu’un contact s’est engagé à verser et que les paiements honorent progressivement. Stockée dans dettes_v2.", "properties": { "cerfa": { "type": "boolean", "default": true, "description": "Choix du reçu fiscal applicable uniquement aux paiements futurs. Les paiements et documents existants conservent leur traitement d’origine." }, "receiptRevision": { "type": "integer", "readOnly": true }, "id": { "type": "string" }, "organisation": { "type": "string" }, "contact": { "type": "string", "description": "Identifiant du contact donateur." }, "contactName": { "type": "string", "readOnly": true, "description": "Nom complet du donateur (calculé à la lecture)." }, "montant": { "type": "number", "description": "Montant de la promesse en unités majeures de la devise (par ex. 50 = 50 €), PAS en centimes — contrairement à Paiement.amount." }, "devise": { "type": "string", "description": "Code de devise (en minuscules, par ex. \"eur\")." }, "assoc": { "type": "string", "description": "Identifiant de l’association à laquelle la promesse est rattachée (\"MAIN\" par défaut)." }, "name": { "type": "string", "description": "Libellé libre de la promesse." }, "type": { "type": "string", "description": "Catégorie/type en texte libre." }, "occasion": { "type": "string", "description": "Campagne/occasion de rattachement (texte libre)." }, "typeId": { "type": "string", "nullable": true, "description": "Identifiant du livret OU de la campagne auquel la promesse est rattachée (sélecteur admin « Livret »). Pour une campagne, la promesse est comptabilisée dans son total ; pour un livret, dans son budget." }, "active": { "type": "boolean" }, "payed": { "type": "number", "readOnly": true, "description": "Montant déjà payé (unités majeures). Calculé à partir des paiements associés — jamais enregistré." }, "reste": { "type": "number", "readOnly": true, "description": "Montant restant à payer (unités majeures). Calculé — jamais enregistré." }, "hasActiveAbonnement": { "type": "boolean", "readOnly": true, "description": "Indique si un abonnement actif honore cette promesse." }, "status": { "type": "string", "readOnly": true, "enum": [ "OPEN", "PARTIAL", "FULFILLED", "COVERED", "CANCELED" ], "description": "Cycle de vie calculé : OPEN (aucun paiement), PARTIAL (partiel), FULFILLED (reste<=0), COVERED (payée par un abonnement actif), CANCELED (annulée)." }, "datetime": { "type": "string", "format": "date-time", "readOnly": true }, "editDatetime": { "type": "string", "format": "date-time", "readOnly": true } } }, "PromesseCreate": { "type": "object", "required": [ "contactId", "montant" ], "properties": { "cerfa": { "type": "boolean", "default": true, "description": "Choix du reçu fiscal applicable uniquement aux paiements futurs. Les paiements et documents existants conservent leur traitement d’origine." }, "contactId": { "type": "string", "description": "Identifiant du contact donateur (doit appartenir à l’organisation)." }, "montant": { "type": "number", "description": "Montant de la promesse en unités majeures de la devise (par ex. 50 = 50 €), PAS en centimes. Doit être > 0." }, "name": { "type": "string", "description": "Libellé libre de la promesse." }, "occasion": { "type": "string", "description": "Campagne/occasion de rattachement (texte libre)." }, "type": { "type": "string", "description": "Catégorie/type en texte libre." }, "assoc": { "type": "string", "description": "Association à laquelle la promesse est rattachée (\"MAIN\" par défaut). FIXÉE à la création — elle détermine la devise et le reçu, et NE PEUT PLUS être modifiée. Consultez GET /associations pour la liste des associations disponibles." }, "typeId": { "type": "string", "description": "Identifiant facultatif du livret OU de la campagne auxquels rattacher la promesse (sélecteur admin « Livret »). Si c’est une campagne, la promesse contribue à son total ; si c’est un livret, à son budget." } } }, "PromesseUpdate": { "type": "object", "description": "N’importe quel sous-ensemble de ces champs. `assoc` et `devise` ne sont PAS modifiables (fixés à la création). Les champs calculés (reste/payed/status) ne sont jamais acceptés.", "properties": { "expectedReceiptRevision": { "type": "integer", "minimum": 0, "description": "Révision du reçu renvoyée lors de la dernière lecture ; permet de refuser une modification fiscale devenue obsolète." }, "cerfa": { "type": "boolean", "default": true, "description": "Choix du reçu fiscal applicable uniquement aux paiements futurs. Les paiements et documents existants conservent leur traitement d’origine." }, "contactId": { "type": "string" }, "montant": { "type": "number", "description": "Unités majeures de la devise, > 0." }, "name": { "type": "string" }, "occasion": { "type": "string" }, "type": { "type": "string" }, "typeId": { "type": "string", "description": "Rattacher à un autre livret/une autre campagne (ou null pour détacher)." } } }, "PromessePaymentLink": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string", "description": "URL de la page de paiement hébergée permettant d’honorer la promesse." }, "reste": { "type": "number", "description": "Montant restant (unités majeures)." }, "devise": { "type": "string" } } }, "Association": { "type": "object", "description": "Association juridique (« association »/cerfa) de l’organisation — détermine la devise et le reçu d’un don. Transmettez son `id` comme `assoc` lors de la création d’une promesse/d’un paiement.", "properties": { "id": { "type": "string", "description": "Identifiant de l’association à utiliser comme `assoc` (\"MAIN\" pour l’association principale de l’organisation)." }, "label": { "type": "string", "description": "Nom d’affichage." }, "devise": { "type": "string", "description": "Code de devise de cette association (en minuscules)." } } }, "FormProduct": { "type": "object", "description": "Ligne de produit d’un formulaire COMPLEX (article acheté).", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "title": { "type": "string" }, "montant": { "type": "number", "description": "Montant unitaire en unités majeures (par ex. euros)." }, "cerfa": { "type": "boolean" }, "simple_stock": { "type": "integer", "nullable": true }, "activeReducedPrice": { "type": "boolean" }, "reducedPercent": { "type": "number", "nullable": true }, "reducedExpireAt": { "type": "string", "format": "date-time", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" } }, "position": { "type": "integer" } } }, "FormDefinition": { "type": "object", "description": "Définition publique d’un formulaire (produits, calendriers, HTML transpilé).", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "type": { "type": "string", "enum": [ "SIMPLE", "COMPLEX" ] }, "title": { "type": "string" }, "active": { "type": "boolean" }, "withPaiement": { "type": "boolean" }, "autoValid": { "type": "boolean" }, "requirePaiementValidation": { "type": "boolean" }, "content": { "type": "string", "description": "HTML transpilé lorsque type=SIMPLE." }, "afficheUrl": { "type": "string", "description": "URL absolue de l’affiche/de l’image de couverture affichée en haut du formulaire (présente si définie)." }, "aiContentBlockId": { "type": "string", "description": "Identifiant du bloc de contenu IA affiché sous forme de bannière enrichie en haut du formulaire (présent s’il est défini)." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/FormProduct" } }, "calendars": { "type": "array", "items": { "type": "object" } }, "expired": { "type": "boolean", "description": "True si la session PE associée n’est plus active." } } }, "FormAdditionalField": { "type": "object", "description": "Champ dynamique ajouté à un formulaire (ou à un produit). Deux portées : les champs GLOBAL (à la racine du formulaire) apparaissent une fois par soumission ; les champs PRODUCT (dans un produit) se répètent pour chaque unité achetée. Utilisez un champ produit uniquement pour recueillir des informations par unité ; tout ce qui concerne la commande entière doit être un champ global.", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "TEXT-INPUT", "TEXTAREA-INPUT", "SELECT-INPUT", "CHECKBOX-INPUT", "DOCS-INPUT", "DATE-INPUT", "TITLE", "CONTACT-INPUT", "FREE-AMOUNT-INPUT" ], "description": "Type de champ. TEXT-INPUT = texte libre sur une ligne ; TEXTAREA-INPUT = texte libre multiligne (avec `height` facultatif en px) ; SELECT-INPUT = liste déroulante (nécessite `values`) ; CHECKBOX-INPUT = oui/non ; DOCS-INPUT = téléversement de fichier (nécessite `doctype`) ; DATE-INPUT = sélecteur de date/heure (`picker`/`dateFilter`/`range`/`defaultNow` facultatifs, date simple par défaut) ; TITLE = séparateur visuel (aucune donnée ; utilise `__title_tag`+`__text`) ; CONTACT-INPUT = contact CRM secondaire (nom+email+téléphone) ; FREE-AMOUNT-INPUT = montant choisi par le donateur (GLOBAL uniquement, exige withPaiement=true, jamais dans un produit)." }, "required": { "type": "boolean", "description": "Indique si le champ est obligatoire." }, "__label": { "type": "string", "description": "Libellé visible du champ." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Options de SELECT-INPUT (obligatoires pour ce type)." }, "doctype": { "type": "string", "enum": [ "IMG", "PDF", "ZIP" ], "description": "Type de fichier autorisé pour DOCS-INPUT." }, "height": { "type": "integer", "description": "TEXTAREA-INPUT uniquement : hauteur fixe de la zone de texte, en pixels (facultative)." }, "picker": { "type": "string", "enum": [ "Date & Heure", "Uniquement les Années", "Uniquement les Mois", "Uniquement l'heure" ], "description": "DATE-INPUT uniquement : granularité. Omettre pour une date simple (JJ/MM/AAAA). \"Date & Heure\" = date et heure ; \"Uniquement les Années\" = année ; \"Uniquement les Mois\" = mois ; \"Uniquement l'heure\" = heure." }, "dateFilter": { "type": "string", "enum": [ "Antérieur à aujourd'hui", "Ultérieur à aujourd'hui", "Aujourd'hui & antérieur à aujourd'hui", "Aujourd'hui & ultérieur à aujourd'hui" ], "description": "DATE-INPUT uniquement : limiter les dates sélectionnables par rapport à aujourd’hui (facultatif)." }, "range": { "type": "boolean", "description": "DATE-INPUT uniquement : choisir une plage début→fin plutôt qu’une seule valeur (facultatif)." }, "defaultNow": { "type": "boolean", "description": "DATE-INPUT uniquement : préremplir avec la date/heure actuelle (facultatif)." }, "__title_tag": { "type": "string", "enum": [ "h1", "h2", "h3", "h4", "h5" ], "description": "Niveau de titre pour TITLE." }, "__text": { "type": "string", "description": "Texte du titre pour TITLE." } } }, "FormProductInput": { "type": "object", "description": "Ligne de produit d’un formulaire (article, billet ou option pouvant être acheté). LES VARIATIONS DE PRIX SE FONT UNIQUEMENT AU MOYEN DE PRODUITS DISTINCTS — jamais avec des options tarifaires sur un seul produit.", "required": [ "label", "title", "montant" ], "properties": { "id": { "type": "string", "description": "Identifiant du produit (omettre à la création ; lors de la modification, correspondance par identifiant ou libellé)." }, "label": { "type": "string", "description": "Libellé interne unique dans le formulaire." }, "title": { "type": "string", "description": "Titre public affiché à l’acheteur." }, "description": { "type": "string", "description": "Description interne (visible par l’admin uniquement)." }, "montant": { "type": "number", "description": "Prix unitaire en unités MAJEURES (par ex. euros). 0 = gratuit. Interprété par mois lorsque paiementType=MONTHLY." }, "cerfa": { "type": "boolean", "description": "Indique si ce produit ouvre droit à un reçu fiscal." }, "active": { "type": "boolean", "description": "Indique si le produit est actif (true par défaut)." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Catégories CRM appliquées au contact UNIQUEMENT lorsque ce produit est sélectionné." }, "simple_stock": { "type": "integer", "description": "Limite de stock pour ce produit. Ignorée lorsque globalStock est défini." }, "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/FormAdditionalField" }, "description": "Champs par produit, répétés pour chaque quantité achetée." } } }, "FormInput": { "type": "object", "description": "Objet métier de l’éditeur pour une DÉFINITION de formulaire — structure à envoyer pour créer ou modifier un formulaire, et structure renvoyée par GET /forms/{id}/edit. Un formulaire est un moteur transactionnel flexible : une soumission peut correspondre à une commande de billets, un achat de plusieurs produits, une inscription familiale, un don, etc. Distinguez le PAYEUR (qui soumet) des BÉNÉFICIAIRES (renseignés dans les champs supplémentaires du produit). Dans un PATCH partiel, omettez `products`/`additionalFields` pour les laisser tels quels ; envoyez-les pour remplacer l’ensemble.", "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Titre public du formulaire (obligatoire)." }, "url": { "type": "string", "description": "Slug public (minuscules, sans accents, espaces remplacés par \"-\"). Facultatif." }, "description": { "type": "string", "description": "Description interne (visible par l’admin uniquement)." }, "afficheUrl": { "type": "string", "description": "URL de l’affiche/de l’image de couverture ou nom du fichier hébergé, affiché en haut du formulaire. Ajoute les métadonnées de partage WhatsApp. Envoyez \"\" pour la supprimer. Peut coexister avec aiContentBlockId (les deux peuvent être définis)." }, "aiContentBlockId": { "type": "string", "nullable": true, "description": "Identifiant d’un bloc de contenu IA (ai_content_blocks), affiché sous forme de bannière HTML enrichie tout en haut du formulaire, au-dessus des champs d’identité. Facultatif — omettre pour ne pas modifier ; envoyer \"\"/null pour le supprimer. Indépendant de afficheUrl (l’image d’affiche) : un formulaire peut afficher les deux." }, "autoValid": { "type": "boolean", "description": "true = soumissions validées automatiquement ; false = validation manuelle." }, "withPaiement": { "type": "boolean", "description": "Activer le paiement en ligne. Si false, tous les champs de paiement ci-dessous sont ignorés." }, "paiementType": { "type": "string", "enum": [ "PAIEMENT", "ABONNEMENT", "MONTHLY" ], "description": "Modèle de facturation : PAIEMENT = paiement ponctuel ; ABONNEMENT = versements limités ; MONTHLY = paiement mensuel récurrent. Nécessite withPaiement=true." }, "onePaiement": { "type": "boolean", "description": "Imposer un paiement unique (sans acompte). Uniquement avec paiementType=PAIEMENT." }, "deposit": { "type": "number", "description": "Montant fixe de l’acompte. paiementType=PAIEMENT et onePaiement=false." }, "depositPercent": { "type": "number", "description": "Acompte en pourcentage (0-100). Même dépendance que `deposit`." }, "abonnementMaxMonth": { "type": "integer", "description": "Nombre maximal de versements (≥2). paiementType=ABONNEMENT." }, "aboMonthInfinite": { "type": "boolean", "description": "Abonnement sans date de fin. paiementType=MONTHLY." }, "aboMonthMin": { "type": "integer", "description": "Nombre minimal de mois d’abonnement (≥1). MONTHLY + aboMonthInfinite=false." }, "aboMonthMax": { "type": "integer", "description": "Nombre maximal de mois d’abonnement (≥ aboMonthMin). MONTHLY + aboMonthInfinite=false." }, "paiementMethods": { "type": "array", "items": { "type": "string" }, "description": "Autres moyens de paiement manuels possibles, par ex. [\"CHEQUE\",\"VIREMENT\",\"ESPECES\"]." }, "requirePaiementValidation": { "type": "boolean", "description": "Validation conditionnée au paiement en ligne. Nécessite withPaiement=true." }, "autoValidOtherPaiementMethod": { "type": "boolean", "description": "Valider automatiquement les paiements par un autre moyen. Nécessite requirePaiementValidation=true." }, "allowZeroAmount": { "type": "boolean", "description": "Autoriser une soumission dont le total est égal à 0." }, "identity": { "type": "string", "enum": [ "SIMPLE" ], "description": "Niveau d’identification du contact. SIMPLE = nom complet + email + téléphone." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Catégories CRM appliquées automatiquement à chaque contact ayant soumis le formulaire." }, "globalStock": { "type": "integer", "nullable": true, "description": "Stock partagé qui remplace les stocks définis par produit." }, "allowNoProduct": { "type": "boolean", "description": "Autoriser l’envoi d’une soumission sans sélectionner de produit." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/FormProductInput" }, "description": "Articles pouvant être achetés. Utilisez des produits distincts pour des prix différents." }, "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/FormAdditionalField" }, "description": "Champs personnalisés globaux (une fois par soumission)." } } }, "Caisse": { "type": "object", "description": "Une cagnotte, telle que renvoyée à la lecture, enrichie des totaux collectés.", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "name": { "type": "string", "description": "Nom public de la cagnotte." }, "label": { "type": "string", "description": "Libellé interne." }, "objectif": { "type": "number", "description": "Objectif de collecte en unités MAJEURES (par ex. euros)." }, "withObjectif": { "type": "boolean", "description": "Indique si une barre de progression vers l’objectif est affichée." }, "marge": { "type": "number", "description": "Frais/marge appliqués." }, "bgimage": { "type": "string", "nullable": true, "description": "Image d’arrière-plan (nom de fichier hébergé)." }, "assoc": { "type": "string", "description": "Identifiant de l’association juridique (\"MAIN\" ou UUID)." }, "typeId": { "type": "string", "description": "Lien vers le livret/PE ; identique à l’identifiant de la cagnotte lorsqu’elle est autonome." }, "active": { "type": "boolean" }, "paused": { "type": "boolean" }, "archived": { "type": "boolean" }, "cerfa": { "type": "boolean", "description": "Indique si les dons versés dans cette cagnotte donnent lieu à un reçu fiscal (true par défaut)." }, "url": { "type": "string", "description": "Slug personnalisé de l’URL publique de la page de la cagnotte." }, "hidden": { "type": "boolean", "description": "Masquer la cagnotte des listes publiques." }, "presetButtons": { "type": "array", "items": { "type": "object" }, "description": "Montants de don prédéfinis proposés aux donateurs." }, "imagesCaroussel": { "type": "array", "items": { "type": "string" }, "description": "Carrousel d’images (noms de fichiers hébergés)." }, "textContent": { "type": "string", "description": "Contenu enrichi de la page." }, "youtubeId": { "type": "string", "description": "Identifiant de la vidéo YouTube affichée sur la page." }, "aiContentBlockId": { "type": "string", "description": "Identifiant du bloc de contenu IA associé." }, "pe": { "type": "string", "nullable": true, "description": "Identifiant de la session Parcours d'Événement à laquelle cette cagnotte est rattachée." }, "payed": { "type": "number", "readOnly": true, "description": "Total collecté à ce jour (calculé)." }, "reste": { "type": "number", "readOnly": true, "description": "Montant restant pour atteindre l’objectif (calculé)." }, "datetime": { "type": "string", "format": "date-time" } } }, "CaisseInput": { "type": "object", "description": "Données pour créer ou modifier une cagnotte. Avec un PATCH partiel, seuls les champs fournis sont modifiés.", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Nom public de la cagnotte (obligatoire à la création)." }, "label": { "type": "string", "description": "Libellé interne (nom par défaut)." }, "objectif": { "type": "number", "description": "Objectif de collecte en unités MAJEURES (par ex. euros)." }, "withObjectif": { "type": "boolean", "description": "Afficher une barre de progression vers l’objectif." }, "marge": { "type": "number", "description": "Frais/marge appliqués (0 par défaut)." }, "bgimage": { "type": "string", "description": "Image d’arrière-plan : URL http(s) (réhébergée côté serveur) ou nom de fichier déjà hébergé." }, "assoc": { "type": "string", "description": "Identifiant de l’association juridique (\"MAIN\" par défaut)." }, "typeId": { "type": "string", "description": "Identifiant du livret/PE auquel rattacher la cagnotte, ou \"AUTO\" pour une cagnotte autonome (rattachée à elle-même)." }, "cerfa": { "type": "boolean", "description": "Indique si les dons versés dans cette cagnotte donnent lieu à un reçu fiscal (true par défaut)." }, "url": { "type": "string", "description": "Slug personnalisé de l’URL publique de la page de la cagnotte." }, "hidden": { "type": "boolean", "description": "Masquer la cagnotte des listes publiques." }, "presetButtons": { "type": "array", "items": { "type": "object" }, "description": "Montants de don prédéfinis proposés aux donateurs." }, "imagesCaroussel": { "type": "array", "items": { "type": "string" }, "description": "Carrousel d’images : chaque entrée est une URL http(s) (réhébergée) ou un nom de fichier déjà hébergé." }, "textContent": { "type": "string", "description": "Contenu enrichi de la page." }, "youtubeId": { "type": "string", "description": "Identifiant de la vidéo YouTube affichée sur la page." }, "aiContentBlockId": { "type": "string", "description": "Identifiant du bloc de contenu IA associé." }, "pe": { "type": "string", "description": "Identifiant de session Parcours d'Événement auquel rattacher cette cagnotte." } } }, "Page": { "type": "object", "description": "Page personnalisée du site web. Identifiée par `route` (segments du slug) — `url` est la route concaténée. Le contenu est soit généré par IA (`html`+`i18n`+`mainLang`), soit issu de l’ancien éditeur visuel (`content`) ; `aiEditable` indique si le contenu peut être modifié via cette API.", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "type": { "type": "string", "enum": [ "MAIN_PAGE", "CUSTOM_PAGE" ], "description": "MAIN_PAGE = ancienne page d’accueil (URL verrouillée ; n’est plus créée automatiquement) ; CUSTOM_PAGE = page standard." }, "editorType": { "type": "string", "enum": [ "AI", "EDITOR" ], "description": "Éditeur propriétaire du contenu : \"AI\" (html + data-i18n, seul type modifiable via cette API) ou \"EDITOR\" (ancien éditeur visuel). Les pages créées via cette API sont toujours de type \"AI\"." }, "label": { "type": "string", "description": "Libellé interne." }, "title": { "type": "string", "description": "Titre public de la page." }, "description": { "type": "string", "description": "Description de la page ; utilisée comme valeur SEO de repli automatique si aucune description SEO de page/site n’est définie." }, "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "fr": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "en": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "he": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "it": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "ru": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "pt": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "de": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "es": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "gr": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "ro": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } }, "additionalProperties": true, "description": "Champs de page traduits, y compris les personnalisations SEO. D’autres contenus de page traduits peuvent également être présents." }, "route": { "type": "array", "items": { "type": "string" }, "description": "Chemin d’URL sous forme de segments de slug (par ex. [\"infos\",\"horaires\"])." }, "url": { "type": "string", "readOnly": true, "description": "Route concaténée (\"infos/horaires\"). Champ pratique en lecture seule." }, "active": { "type": "boolean" }, "html": { "type": "string", "description": "HTML du contenu IA (avec attributs data-i18n). Présent sur les pages IA." }, "mainLang": { "type": "string", "nullable": true, "description": "Langue par défaut du contenu HTML." }, "i18n": { "type": "object", "description": "Traductions : { lang: { i18nKey: value } } pour les clés data-i18n du HTML.", "additionalProperties": true }, "aiEditable": { "type": "boolean", "readOnly": true, "description": "Indique si le contenu de la page peut être modifié via PUT /pages/{id}/content (false pour les pages de l’ancien éditeur visuel)." }, "datetime": { "type": "string", "format": "date-time" } } }, "PageSeoOverlay": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Traduction SEO partielle pour une autre langue activée. La langue par défaut de l’organisation reste à la racine. Seuls les champs fournis sont modifiés. Null ou un objet vide efface uniquement le SEO de cette langue et préserve les autres traductions du contenu de la page ; l’effacement d’un SEO obsolète reste autorisé après désactivation d’une langue. Les champs acceptent null/chaînes vides pour rétablir la valeur de repli. À distinguer des dictionnaires i18n du HTML.", "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." } } }, "PageInput": { "type": "object", "description": "Données pour créer ou modifier les métadonnées et le SEO d’une page (metaTitle/metaDescription/metaImage). Une page créée ici est une page IA (son contenu peut ensuite être défini via PUT /pages/{id}/content). Avec un PATCH partiel, seuls les champs fournis sont modifiés, y compris dans une surcharge linguistique. La modification du SEO fonctionne pour les pages IA et celles de l’ancien éditeur. La langue par défaut reste à la racine ; les autres langues activées utilisent des surcharges. Les champs SEO remplacent chacun indépendamment les valeurs du site ; null/champ vide rétablit la valeur de repli. Ce mécanisme est distinct des traductions HTML data-i18n.", "required": [ "title", "url" ], "properties": { "label": { "type": "string", "description": "Libellé interne." }, "title": { "type": "string", "description": "Titre public de la page (obligatoire à la création)." }, "description": { "type": "string", "description": "Description de la page ; valeur SEO de repli automatique lorsqu’aucune description SEO de page/site n’est définie." }, "metaTitle": { "type": "string", "nullable": true, "description": "Titre SEO et de partage propre à la page ; remplace la valeur par défaut du site sans modifier le titre visible. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaDescription": { "type": "string", "nullable": true, "description": "Description meta et de partage propre à la page ; remplace la valeur par défaut du site. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "metaImage": { "type": "string", "nullable": true, "description": "Image de partage propre à la page : URL HTTP(S) (réhébergée côté serveur) ou nom de fichier déjà hébergé, y compris les images traduites. Null ou une chaîne vide supprime cette personnalisation et rétablit la valeur de repli du site/automatique." }, "fr": { "$ref": "#/components/schemas/PageSeoOverlay" }, "en": { "$ref": "#/components/schemas/PageSeoOverlay" }, "he": { "$ref": "#/components/schemas/PageSeoOverlay" }, "it": { "$ref": "#/components/schemas/PageSeoOverlay" }, "ru": { "$ref": "#/components/schemas/PageSeoOverlay" }, "pt": { "$ref": "#/components/schemas/PageSeoOverlay" }, "de": { "$ref": "#/components/schemas/PageSeoOverlay" }, "es": { "$ref": "#/components/schemas/PageSeoOverlay" }, "gr": { "$ref": "#/components/schemas/PageSeoOverlay" }, "ro": { "$ref": "#/components/schemas/PageSeoOverlay" }, "url": { "type": "string", "description": "URL de la page, par ex. \"infos/horaires\" (obligatoire à la création). Normalisée côté serveur en segments de slug ; doit être unique et ne pas entrer en conflit avec une page intégrée. L’URL de la page d’accueil ne peut pas être modifiée." }, "active": { "type": "boolean", "description": "Indique si la page est publiée (true par défaut)." } } }, "PageContentInput": { "type": "object", "description": "Contenu HTML d’une page IA. Envoyez du HTML BRUT — vous n’avez PAS à gérer vous-même les clés de traduction. Le serveur traite le HTML et ajoute un attribut `data-i18n=\"\"` sur chaque nœud de texte traduisible qui n’en possède pas (et `data-i18n-alt`/`-title`/`-placeholder`/`-aria-label` pour ces attributs), en générant des clés telles que `auto_1`. Le texte de `mainLang` devient le dictionnaire de référence ; les traductions existantes dans les autres langues sont conservées et les clés obsolètes supprimées. Pour traduire, relisez la page afin d’obtenir les clés, puis appelez POST /pages/{id}/translations avec `{lang, dict:{key:value}}`. Refusé avec PAGE_CONTENT_NOT_EDITABLE pour les pages de l’ancien éditeur.", "required": [ "html" ], "properties": { "html": { "type": "string", "description": "HTML de la page (fragment ou document complet). Les clés data-i18n sont ajoutées automatiquement." }, "mainLang": { "type": "string", "description": "Langue utilisée pour rédiger le HTML (par ex. \"fr\"). Par défaut, mainLang actuel de la page ou langue par défaut de l’organisation." }, "assets": { "type": "array", "items": { "type": "string" }, "description": "Noms de fichiers facultatifs des ressources référencées dans le HTML." } } }, "PageTranslationsInput": { "type": "object", "description": "Traductions des clés data-i18n existantes d’une page IA pour une langue. Ne modifie pas le HTML. Lisez la page (son `i18n` et les clés `data-i18n` de `html`) pour découvrir les clés.", "required": [ "lang", "dict" ], "properties": { "lang": { "type": "string", "description": "Code de la langue cible (par ex. \"en\", \"he\")." }, "dict": { "type": "object", "description": "{ i18nKey: translatedValue } (valeur traduite).", "additionalProperties": { "type": "string" } } } }, "ContentBlock": { "type": "object", "description": "Bloc de contenu IA réutilisable : fragment HTML autonome affiché sur le site public partout où son `id` est référencé (par ex. sur la page d’accueil touristique via `homepage.aiContentBlockId` dans la configuration Travel, ou dans l’introduction d’un groupe d’événements à sessions multiples). Contient le HTML avec des clés `data-i18n` ainsi que le dictionnaire `i18n` de leurs traductions.", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "html": { "type": "string", "description": "Fragment HTML du bloc (avec attributs data-i18n)." }, "mainLang": { "type": "string", "nullable": true, "description": "Langue par défaut utilisée pour rédiger le HTML." }, "i18n": { "type": "object", "description": "Traductions : { lang: { i18nKey: value } } pour les clés data-i18n du HTML.", "additionalProperties": true }, "assets": { "type": "array", "items": { "type": "string" }, "description": "Noms de fichiers des ressources référencées dans le HTML." }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "datetime": { "type": "string", "format": "date-time", "readOnly": true } } }, "ContentBlockContentInput": { "type": "object", "description": "Contenu HTML d’un bloc IA. Envoyez du HTML BRUT — vous n’avez PAS à gérer vous-même les clés de traduction : le serveur ajoute un attribut `data-i18n=\"\"` sur chaque nœud de texte traduisible qui n’en possède pas (et `data-i18n-alt`/`-title`/`-placeholder`/`-aria-label` pour ces attributs), en générant des clés telles que `auto_1`. Le texte de `mainLang` devient le dictionnaire de référence ; les traductions existantes des autres langues sont conservées et les clés obsolètes supprimées (conservez donc les clés data-i18n existantes lorsque vous modifiez de nouveau le contenu). Le bloc est affiché partout où son identifiant est référencé (par ex. sur la page d’accueil touristique).\n\nRÈGLES DE RÉDACTION OBLIGATOIRES pour le HTML (identiques à celles de l’éditeur IA intégré, puisqu’aucun éditeur ne peut les imposer ici) :\n• Produisez uniquement un FRAGMENT — aucun , , ni ; commencez directement par
/
/
.\n• Placez tout le contenu dans un conteneur centré : max-width:1200px ; margin:0 auto ; padding latéral de 24px sur ordinateur / 16px sur mobile.\n• Préfixez TOUTES les classes CSS par `.aicb-` (par ex. .aicb-hero, .aicb-card) pour éviter les conflits avec la page hôte.\n• N’utilisez JAMAIS les unités de hauteur de fenêtre vh/vmin/vmax (le bloc est affiché dans une iframe à hauteur automatique → boucle infinie) ; utilisez px/rem ou min-height:600px pour les sections de bannière principale. vw (largeur) est autorisé.\n• Placez