Skip to content

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.

ReferenceAdministratorDeveloper

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

documentTypeLibellé courtLibellé longAdresse publique
CGVCGVConditions Générales de Vente/legal/cgv
CGUCGUConditions Générales d'Utilisation/legal/cgu
CHARTE_RGPDCharte RGPDCharte de confidentialité (RGPD)/legal/rgpd
DPADPAData Processing Agreement/legal/dpa
DPA_HDSDPA HDSAnnexe HDS pour le DPA/legal/dpa-hds (application HDS)

Objet document

ChampTypeDescription
idUUIDidentifiant de la version
documentTypechaînetype, voir le tableau des types
versionchaîne20 caractères au plus, par exemple 1.2 ; incrément du dernier chiffre à chaque nouvelle version
namechaîne200 caractères au plus ; par défaut « <type> — <application> v<version> »
contentchaîneMarkdown, avec variables {{…}} éventuelles
effectiveDatedate ISO 8601date d'entrée en vigueur
isActivebooléenversion en vigueur ; une seule par type

Statuts de la page légale

Statut affichéSignification
Non configuréeaucun rattachement
Configurée, non publiéerattachée à un environnement et une URL, rien de publié
Publiéeune publication est en ligne ; l'adresse est affichée
Détachéela page ne répond plus ; le contenu est conservé

Adresses publiques

CheminContenu
/legalliste des documents publiés
/legal/<type>version active
/legal/<type>/versionshistorique complet, contenu compris
/legal/download.pdfPDF 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.

GET/api/legal-documents

Toutes les versions de tous les types. Paramètre de requête obligatoire : appWid.

GET/api/legal-documents/default

Version active d'un type. Paramètres : appWid (obligatoire), documentType (CGV par défaut).

POST/api/legal-documents/{id}/render

Texte du document avec variables remplacées. Corps : entity (obligatoire), contact (obligatoire), date (facultatif). Réponse : { "rendered": "…" }.

CodeCas
401clé API absente ou invalide
404application inconnue ; « Aucun document légal actif de type … pour cette application » ; document introuvable
400corps de rendu invalide, ou champ inconnu

Variables de rendu

EspaceChamps
entityentityName, legalName, legalForm, legalCountry, businessRegistrationId, commercialRegistryNumber, vatNumber, fiscalYearEnd, address.street1, address.street2, address.street3, address.postalCode, address.city, address.country
contactfirstname, lastname, email, job
datemasque libre : yyyy, mm, dd, hh, nn, ss (UTC), par exemple {{date.dd/mm/yyyy}}