Aller au contenu

Lire les documents légaux par l'API

Récupérer depuis votre serveur les documents légaux de votre application avec une clé API, puis les personnaliser avec les informations d'un client.

GuideDéveloppeur
Accès requis
Clé API de l'application (en-tête x-api-key)
Durée
15 min
Voir en Markdown

Votre application peut afficher ses CGU dans son propre parcours d'inscription, ou produire un contrat au nom d'un client. L'API publique donne accès aux documents légaux en lecture, avec une clé API.

Avant de commencer

  • Créez une clé API pour votre application. Ces appels n'acceptent que la clé API, dans l'en-tête x-api-key, et non un jeton d'utilisateur.
  • Gardez la clé côté serveur : ne l'embarquez jamais dans un front.
  • Repérez le WID de votre application, par exemple EXAPP1.

Lire le document actif d'un type

Bash
curl "https://api.wakastart.app/api/legal-documents/default?appWid=EXAPP1&documentType=CGU" \
  -H "x-api-key: sk_test_exemple"
TypeScript
const res = await fetch(
  "https://api.wakastart.app/api/legal-documents/default?appWid=EXAPP1&documentType=CGU",
  { headers: { "x-api-key": process.env.WAKASTART_API_KEY! } },
);
if (!res.ok) throw new Error(`CGU indisponibles : ${res.status}`);
const cgu = await res.json();
console.log(cgu.version, cgu.effectiveDate);

Réponse attendue (200 OK) :

JSON
{
  "id": "c1d2e3f4-0000-4000-8000-000000000010",
  "documentType": "CGU",
  "version": "1.2",
  "name": "CGU — Mon App v1.2",
  "content": "# Conditions générales d'utilisation\n\nLes présentes conditions …",
  "effectiveDate": "2026-11-01T00:00:00.000Z",
  "isActive": true
}

Sans documentType, l'API renvoie les CGV. content est en Markdown : convertissez-le en HTML avec la bibliothèque de votre choix avant de l'afficher.

Lire toutes les versions

GET /api/legal-documents?appWid=EXAPP1 renvoie toutes les versions de tous les types, contenu compris. isActive distingue la version en vigueur de l'historique.

Bash
curl "https://api.wakastart.app/api/legal-documents?appWid=EXAPP1" \
  -H "x-api-key: sk_test_exemple"

Réponse attendue (extrait) :

JSON
[
  { "id": "c1d2e3f4-0000-4000-8000-000000000010", "documentType": "CGU", "version": "1.2", "isActive": true, "effectiveDate": "2026-11-01T00:00:00.000Z", "name": "CGU — Mon App v1.2", "content": "…" },
  { "id": "c1d2e3f4-0000-4000-8000-000000000009", "documentType": "CGU", "version": "1.1", "isActive": false, "effectiveDate": "2026-03-01T00:00:00.000Z", "name": "CGU — Mon App v1.1", "content": "…" }
]

Conservez l'id et la version acceptés par chaque utilisateur : vous pourrez prouver quel texte il a accepté.

Personnaliser un document pour un client

POST /api/legal-documents/{id}/render remplace les variables {{…}} du document par les informations que vous envoyez.

Bash
curl -X POST "https://api.wakastart.app/api/legal-documents/c1d2e3f4-0000-4000-8000-000000000011/render" \
  -H "x-api-key: sk_test_exemple" \
  -H "Content-Type: application/json" \
  -d '{
    "entity": {
      "entityName": "Clinique Exemple",
      "legalName": "Clinique Exemple SAS",
      "legalForm": "SAS",
      "legalCountry": "FR",
      "businessRegistrationId": "123456789",
      "address": { "street1": "1 rue de l Exemple", "postalCode": "75001", "city": "Paris", "country": "France" }
    },
    "contact": { "firstname": "Marie", "lastname": "Durand", "email": "marie.durand@clinique-exemple.fr", "job": "Directrice" },
    "date": "2026-11-01T00:00:00Z"
  }'
TypeScript
const rendered = await fetch(
  `https://api.wakastart.app/api/legal-documents/${documentId}/render`,
  {
    method: "POST",
    headers: {
      "x-api-key": process.env.WAKASTART_API_KEY!,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      entity: { entityName: "Clinique Exemple", legalCountry: "FR" },
      contact: { firstname: "Marie", lastname: "Durand", email: "marie.durand@clinique-exemple.fr" },
    }),
  },
).then((r) => r.json());
console.log(rendered.rendered);

Réponse attendue (200 OK) :

JSON
{
  "rendered": "# Contrat\n\nEntre Clinique Exemple SAS, SAS immatriculée sous le numéro 123456789, représentée par Marie Durand, Directrice, le 01/11/2026 …"
}
ChampObligatoireContraintes
entity.entityNameoui200 caractères
entity.legalCountryoui100 caractères
entity.legalName, entity.legalFormnon200 et 100 caractères
entity.businessRegistrationId, entity.commercialRegistryNumbernon100 caractères
entity.vatNumber, entity.fiscalYearEndnon50 et 20 caractères
entity.addressnonlignes de 200 caractères, code postal 20, ville et pays 100
contact.firstname, contact.lastnameoui100 caractères
contact.emailouie-mail valide, 255 caractères
contact.jobnon100 caractères
datenonISO 8601 ; par défaut, maintenant. Sert aux variables {{date.…}}

Une variable inconnue reste telle quelle dans le texte rendu.

Vérifier le résultat

  • Le document actif lu par l'API a la même version que celle affichée dans l'onglet Légal de la console.
  • Le texte rendu ne contient plus de variable {{entity.…}} ni {{contact.…}}.

Voir aussi