Référence des documents légaux
Types, champs d'un document, statuts de la page légale, adresses publiques, endpoints de l'API publique et limites.
This page has not been translated yet and is shown in French.
Valeurs de référence des documents légaux. Le détail des endpoints figure aussi dans la référence API des documents légaux.
Types
documentType | Libellé court | Libellé long | Adresse publique |
|---|---|---|---|
CGV | CGV | Conditions Générales de Vente | /legal/cgv |
CGU | CGU | Conditions Générales d'Utilisation | /legal/cgu |
CHARTE_RGPD | Charte RGPD | Charte de confidentialité (RGPD) | /legal/rgpd |
DPA | DPA | Data Processing Agreement | /legal/dpa |
DPA_HDS | DPA HDS | Annexe HDS pour le DPA | /legal/dpa-hds (application HDS) |
Objet document
| Champ | Type | Description |
|---|---|---|
id | UUID | identifiant de la version |
documentType | chaîne | type, voir le tableau des types |
version | chaîne | 20 caractères au plus, par exemple 1.2 ; incrément du dernier chiffre à chaque nouvelle version |
name | chaîne | 200 caractères au plus ; par défaut « <type> — <application> v<version> » |
content | chaîne | Markdown, avec variables {{…}} éventuelles |
effectiveDate | date ISO 8601 | date d'entrée en vigueur |
isActive | booléen | version en vigueur ; une seule par type |
Statuts de la page légale
| Statut affiché | Signification |
|---|---|
| Non configurée | aucun rattachement |
| Configurée, non publiée | rattachée à un environnement et une URL, rien de publié |
| Publiée | une publication est en ligne ; l'adresse est affichée |
| Détachée | la page ne répond plus ; le contenu est conservé |
Adresses publiques
| Chemin | Contenu |
|---|---|
/legal | liste des documents publiés |
/legal/<type> | version active |
/legal/<type>/versions | historique complet, contenu compris |
/legal/download.pdf | PDF consolidé (documents-legaux.pdf) |
Le chemin /legal est fixe. Une nouvelle publication est prise en compte en 30 secondes au plus.
Endpoints de l'API publique
URL de base : https://api.wakastart.app/api. Authentification : clé API dans l'en-tête x-api-key.
/api/legal-documentsToutes les versions de tous les types. Paramètre de requête obligatoire : appWid.
/api/legal-documents/defaultVersion active d'un type. Paramètres : appWid (obligatoire), documentType (CGV par défaut).
/api/legal-documents/{id}/renderTexte du document avec variables remplacées. Corps : entity (obligatoire), contact (obligatoire), date (facultatif). Réponse : { "rendered": "…" }.
| Code | Cas |
|---|---|
401 | clé API absente ou invalide |
404 | application inconnue ; « Aucun document légal actif de type … pour cette application » ; document introuvable |
400 | corps de rendu invalide, ou champ inconnu |
Variables de rendu
| Espace | Champs |
|---|---|
entity | entityName, legalName, legalForm, legalCountry, businessRegistrationId, commercialRegistryNumber, vatNumber, fiscalYearEnd, address.street1, address.street2, address.street3, address.postalCode, address.city, address.country |
contact | firstname, lastname, email, job |
date | masque libre : yyyy, mm, dd, hh, nn, ss (UTC), par exemple {{date.dd/mm/yyyy}} |