Documentation · v1
Lecture des données de votre réseau. Une clé par intégration, cloisonnée à votre réseau, limitée aux domaines que vous cochez. Aucune écriture n'est possible.
https://api.ldde.fr/v1
Créez une clé depuis Paramètres → API, cochez les domaines dont votre application a besoin, et copiez le secret : il n'est lisible qu'une fois. Puis vérifiez qu'elle fonctionne.
curl -H "Authorization: Bearer VOTRE_CLE" \
https://api.ldde.fr/v1/meLa réponse dit pour quel réseau la clé travaille, ce qu'elle a le droit de lire et ce qu'il lui reste de quota. C'est l'appel à faire en premier, avant d'écrire la moindre ligne de code métier.
Toutes les réponses ont la même forme. meta.generated_at dit la
fraîcheur réelle : une partie des données vient d'une synchronisation, pas du
temps réel.
{
"data": [ … ],
"meta": { "generated_at": "…", "resource": "locations", "per_page": 50, "has_more": true },
"links": { "next": "…" }
}
Par curseur. Suivez links.next tant qu'il est présent, sans jamais
fabriquer un curseur vous-même. Une pagination par numéro de page se décale dès
qu'une ligne est insérée pendant le parcours : sur des dizaines de milliers
d'enregistrements, vous en verriez certains deux fois et d'autres jamais.
Toutes les ressources acceptent updated_since. Sans lui, votre outil
reprend tout à chaque passage.
https://api.ldde.fr/v1/locations?updated_since=2026-07-01T00:00:00%2B02:00%2B.
Dans une chaîne de requête, un « + » brut est décodé en espace. Nous le réparons,
mais mieux vaut ne pas dépendre de cette réparation.
Chaque réponse porte X-RateLimit-Limit et
X-RateLimit-Remaining, à la minute et à la journée. Un dépassement
répond 429 avec Retry-After. Régulez-vous dessus plutôt
que d'attendre le refus.
Aucun verbe d'écriture n'existe. Un POST, un PUT ou un
DELETE répond 405, quel que soit le chemin.
Une clé ne lit que les domaines cochés à sa création. Un appel hors périmètre
répond 403 en nommant celui qui manque.
network:read
Agences, zones, couverture géographique.
/franchisees, /zones
reputation:read
Fiches Google, notes, avis publics, historique.
/locations, /reviews
stats:read
Agrégats d'activité et séries temporelles du réseau.
/monthly-stats
rating:read
Notes des agences, classement, distribution des grades.
/ratings
satisfaction:read
Baromètre agrégé, sans verbatim nominatif.
/satisfaction-responses
ads:read
Comptes Google Ads, dépenses et conversions par agence.
/ads-accounts, /ads-daily-stats, /ads-conversions, /ads-calls
sales:read
Opportunités, devis, factures, règlements.
/opportunities, /quotations, /invoices, /payments, /dunning-actions, /dunning-disputes
worksites:read
Chantiers, volumes traités, déchets déclarés.
/worksites, /waste-movements
royalties:read
Calculs et factures de redevances du siège.
/royalty-calculations
agenda:read
Rendez-vous et réunions.
/meetings, /rdv-bookings
communication:read
Actualités publiées au réseau et taux de lecture agrégés.
/announcements
careers:read
Offres d'emploi publiées par les agences du réseau.
/job-offers
shop:read
Catalogue de la centrale d'achat et commandes des agences.
/shop-products, /shop-orders
knowledge:read
Articles du savoir-faire, leurs rubriques et leurs versions.
/kb-articles
training:read
Parcours de formation et avancement par agence.
/training-progress
compliance:read
Exigences du réseau, état des documents obligatoires et échéances par agence.
/compliance-requirements, /compliance-items
fleet:read
Parc de véhicules, affectations aux agences et journal d'entretien.
/vehicles, /vehicle-assignments, /vehicle-events
brand:read
Bibliothèque de marque, gabarits de supports et productions des agences.
/brand-assets, /support-templates, /support-generations
leads:read
Données personnelles
Demandes entrantes, avec les coordonnées des prospects.
/leads
recruitment:read
Données personnelles
Candidatures de franchisés, avec les coordonnées des candidats.
/candidates
customers:read
Données personnelles
Fiches clients des agences, coordonnées comprises.
/customers
finance:read
Données personnelles
Synthèses financières mensuelles figées : chiffre d'affaires, charges, marge, redevances, encours par agence.
/finance-snapshots
Chaque ressource se lit en liste (GET /nom) et à l'unité
(GET /nom/{id}). Les champs listés sont les seuls renvoyés.
GET /franchisees
network:read
Les agences du réseau : identité commerciale et implantation.
id slug name city postal_code department country phone website latitude longitude logo_url status active joined_at updated_at city postal_code status active updated_since company_name city postal_code joined_at updated_at (défaut : company_name)
GET /zones
network:read
Les zones de territoire, attribuées ou libres.
id code name departments population communes_count median_income latitude longitude franchisee_id franchisee assigned reserved reserved_until available updated_at franchisee assigned available updated_since code name population updated_at (défaut : code)
GET /candidates
recruitment:read
Les candidatures de franchisés : origine, zone visée, étape, apport déclaré.
id reference first_name last_name email phone city postal_code zone_id zone source stage stage_label status lost_reason personal_funds current_situation has_experience owner next_action_at dip_sent_at contract_signed_at converted_franchisee_id consent_at anonymized created_at updated_at stage status source zone city lost_reason min_funds converted since until updated_since created_at next_action_at personal_funds updated_at (défaut : -created_at)
GET /locations
reputation:read
Les fiches Google Business du réseau, avec leur note et leur volume d'avis.
id name short_name store_code place_id city postal_code region country address latitude longitude category rating reviews_count has_reviews reviews_replied rating_distribution franchisee_id franchisee google_url last_sync_at updated_at franchisee city postal_code min_rating with_reviews updated_since name city average_rating total_reviews updated_at (défaut : -total_reviews)
GET /reviews
reputation:read
Les avis publics des fiches du réseau, avec la réponse publiée le cas échéant.
id platform location_id location city franchisee_id author author_photo_url rating comment reply replied reviewed_at replied_at updated_at location min_rating max_rating replied since until updated_since review_date rating updated_at (défaut : -review_date)
GET /ads-accounts
ads:read
Les comptes Google Ads du réseau et leur état de synchronisation.
id customer_id name descriptive_name account_type currency timezone franchisee_id franchisee active sync_status last_sync_at updated_at franchisee active updated_since name updated_at (défaut : name)
GET /ads-daily-stats
ads:read
Les performances publicitaires jour par jour, par agence : coût, clics, conversions, ROAS.
id date franchisee_id franchisee account_id impressions clicks cost conversions conversions_value ctr cpc cpa declared_value_ratio roas campaigns updated_at franchisee account since until updated_since date cost clicks conversions updated_at (défaut : -date)
GET /ads-conversions
ads:read
Les conversions hors ligne remontées à Google Ads, du lead à la vente, avec leur valeur réelle.
id order_id stage franchisee_id franchisee value converted_at uploaded_at adjusted_at accepted failed error updated_at franchisee stage failed since until updated_since conversion_at value updated_at (défaut : -conversion_at)
GET /ads-calls
ads:read
Les appels téléphoniques venus d'une annonce, et leur rapprochement avec un lead qualifié.
id franchisee_id franchisee called_at duration_seconds answered status type campaign caller_area_code match_status qualified order_id value uploaded_at error updated_at franchisee status qualified answered since until updated_since call_start_at duration_seconds matched_value updated_at (défaut : -call_start_at)
GET /monthly-stats
stats:read
L'activité de chaque agence, mois par mois : chiffre d'affaires, devis, opportunités, encaissements.
id franchisee_id franchisee year month period revenue invoices_count invoices_total quotations_count quotations_total quotations_signed quotations_signed_total quotations_pending quotations_rejected opportunities_count leads_count own_leads_count opportunities_won payments_total new_customers_count conversion_rate signature_rate_amount average_basket average_quotation_value average_deal_cycle_days updated_at franchisee year month updated_since year month revenue updated_at (défaut : -year)
GET /opportunities
sales:read
Les affaires en cours et closes, leur étape de pipeline et leur montant.
id name customer_id amount status won from_phone pipeline stage closed_at created_at updated_at status won min_amount since until updated_since amount closed_at updated_at (défaut : -updated_at)
GET /quotations
sales:read
Les devis émis par les agences, avec leur montant et leur sort.
id number title customer_id franchisee_id franchisee total_ht total_ttc status signed channel quoted_at answered_at expires_at age_days days_to_answer dormant pdf_url updated_at franchisee status channel signed dormant min_amount since until updated_since quote_date total_ht total_ttc updated_at (défaut : -quote_date)
GET /invoices
sales:read
Les factures des agences, leur encaissement et leur canal d'origine.
id number customer_id franchisee_id franchisee total_ht total_ttc outstanding_amount paid channel invoiced_at due_at paid_at pdf_url updated_at franchisee paid channel since until updated_since invoice_date total_ttc paid_date updated_at (défaut : -invoice_date)
GET /payments
sales:read
Les règlements encaissés, rattachés à leur facture.
id invoice_id amount nature reference paid_at updated_at invoice since until updated_since payment_date amount updated_at (défaut : -payment_date)
GET /worksites
worksites:read
Les chantiers : planification, volumes traités, montants. Sans les coordonnées du client.
id reference franchisee_id franchisee customer_id city postal_code type status crew_size estimated_volume_m3 actual_volume_m3 estimated_amount_ht actual_amount_ht scheduled_start_at actual_start_at actual_end_at signed_at updated_at franchisee status type city since until updated_since scheduled_start_at actual_volume_m3 updated_at (défaut : -scheduled_start_at)
GET /waste-movements
worksites:read
Le registre des déchets : quantités déposées, converties en poids et en volume.
id franchisee_id franchisee worksite_id category outlet moved_at quantity unit weight_kg volume_m3 cost_ht status has_receipt updated_at franchisee worksite status since until updated_since moved_at weight_kg updated_at (défaut : -moved_at)
GET /vehicles
fleet:read
Le parc de véhicules du réseau : identité technique, état, agence qui l'exploite.
id registration title asset_type quantity brand model version category category_label payload_kg volume_m3 first_registered_at owner_type status status_label mileage mileage_read_at franchisee_id franchisee updated_at status category owner_type in_fleet updated_since registration status mileage updated_at (défaut : registration)
GET /vehicle-assignments
fleet:read
Qui exploite quel véhicule, depuis quand et jusqu'à quand. Sans les loyers.
id vehicle_id vehicle franchisee_id franchisee start_at end_at status mileage_at_start mileage_at_end checkin_signed_at checkout_signed_at updated_at vehicle franchisee status since until updated_since start_at status updated_at (défaut : -start_at)
GET /vehicle-events
fleet:read
Le journal d'un véhicule : entretiens, réparations, sinistres, immobilisations.
id vehicle_id vehicle franchisee_id franchisee type type_label occurred_at mileage supplier cost_ht is_under_warranty days_immobilised updated_at vehicle franchisee type since until updated_since occurred_at cost_ht updated_at (défaut : -occurred_at)
GET /ratings
rating:read
Les notes des agences par période, avec le détail des critères.
id franchisee_id franchisee rating_type year period_start period_end total_score grade scores updated_at franchisee type year grade updated_since period_end total_score updated_at (défaut : -period_end)
GET /satisfaction-responses
satisfaction:read
Les retours clients, réduits à leur note et à leur sentiment. Sans identité ni verbatim.
id type franchisee_id franchisee status rating sentiment left_google_review sent_at responded_at updated_at franchisee type sentiment min_rating since until updated_since responded_at rating_overall updated_at (défaut : -responded_at)
GET /royalty-calculations
royalties:read
Les redevances calculées par agence et par mois, de l'assiette au montant dû.
id franchisee_id franchisee year month period gross_revenue taxable_revenue rate_applied royalty_amount total_amount status due_at paid_at updated_at franchisee status year month updated_since year month total_amount updated_at (défaut : -year)
GET /meetings
agenda:read
Les réunions et webinaires du réseau.
id title status is_webinar starts_at ends_at timezone updated_at status since until updated_since starts_at updated_at (défaut : -starts_at)
GET /rdv-bookings
agenda:read
Les créneaux de rendez-vous réservés, sans les coordonnées du prospect.
id franchisee_id franchisee status source starts_at ends_at updated_at franchisee status since until updated_since starts_at updated_at (défaut : -starts_at)
GET /job-offers
careers:read
Les offres d'emploi publiées par les agences du réseau.
id reference slug title contract_type contract_label contract_duration_months employment_type working_time hours_per_week experience_level description missions profile benefits salary_min salary_max salary_period city postal_code latitude longitude remote positions_count start_date published_at expires_at employer employer_legal_form employer_rcs_city employer_legal_line agency_slug apply_url updated_at city postal_code contract_type working_time experience_level remote agency updated_since published_at expires_at title city updated_at (défaut : -published_at)
GET /announcements
communication:read
Les actualités publiées au réseau, avec leurs compteurs de lecture.
id title excerpt category category_label severity is_pinned requires_ack audience_type status published_at expires_at reads_count acks_count updated_at category severity status requires_ack since until updated_since published_at title updated_at (défaut : -published_at)
GET /kb-articles
knowledge:read
Les articles publiés du savoir-faire, avec leur rubrique et leur version.
id slug title excerpt category_id category tags video_url version requires_ack views_count published_at updated_at category requires_ack since updated_since title published_at updated_at (défaut : title)
GET /training-progress
training:read
L'avancement des agences sur les parcours de formation.
id training_path_id path is_mandatory franchisee_id franchisee status percent steps_done steps_total overdue started_at due_at completed_at updated_at franchisee path status overdue updated_since due_at completed_at updated_at (défaut : -updated_at)
GET /compliance-requirements
compliance:read
Le référentiel des documents obligatoires exigés par le réseau.
id code label description category category_label applies_to periodicity period_months requires_proof alert_days is_blocking_flagged updated_at category applies_to requires_proof updated_since sort_order code label updated_at (défaut : sort_order)
GET /compliance-items
compliance:read
L'état des documents obligatoires par agence : feu, période de validité, échéance.
id requirement_id code label category subject_type subject_id franchisee_id status valid_from valid_until has_proof awaiting_review verified_at status_computed_at updated_at status requirement subject_type franchisee expiring_before awaiting_review updated_since valid_until status updated_at (défaut : valid_until)
GET /customers
customers:read
Les clients des agences, coordonnées comprises. Périmètre nominatif.
id customer_id name email phone mobile contact_firstname contact_lastname address_street postal_code city is_company is_prospect franchisee_id franchisee outstanding_amount updated_at city postal_code is_company updated_since name updated_at (défaut : name)
GET /leads
leads:read
Les demandes entrantes, avec les coordonnées du prospect. Périmètre nominatif.
id status source channel firstname lastname company_name email phone postal_code city subject message prestation_type client_type estimated_amount utm_source utm_medium utm_campaign gclid landing_page referrer consent_ads franchisee_id franchisee in_zone received_at updated_at status channel source franchisee postal_code since until updated_since received_at status updated_at (défaut : -received_at)
GET /finance-snapshots
finance:read
La synthèse financière figée de chaque mois clos : chiffre d'affaires, charges, marge, redevances et encours, pour le réseau et pour chaque agence. Montants hors taxes.
id scope_type franchisee_id franchisee period revenue expenses result margin_rate royalties_due royalties_collected royalties_overdue receivables receivables_overdue dso_days waste_cost computed_at recomputed_count updated_at scope franchisee period since until updated_since period computed_at updated_at (défaut : -period)
GET /dunning-actions
sales:read
Les relances de factures impayées menées par les agences : nature du geste, résultat, promesse de paiement obtenue. Sans le contenu des notes.
id franchisee_id franchisee invoice_key invoice_id invoice_number customer_id invoice_amount_ht invoice_due_at type type_label outcome outcome_label automatic promised_at promised_amount performed_at updated_at franchisee invoice customer type outcome automatic since until updated_since performed_at promise_date updated_at (défaut : -performed_at)
GET /dunning-disputes
sales:read
Les factures contestées par un client : ouverture, montant en jeu, issue. Sans le motif, qui est une note interne à l'agence.
id franchisee_id franchisee invoice_key invoice_id invoice_number customer_id status status_label open amount_disputed opened_at resolved_at updated_at franchisee invoice customer status open since until updated_since opened_at resolved_at updated_at (défaut : -opened_at)
GET /brand-assets
brand:read
La bibliothèque de marque : ce qui existe, dans quelle catégorie, avec quels droits d'usage, et ce qui a été remplacé. Sans les fichiers eux-mêmes.
id name description category category_label tags usage_rights usage_rights_label format width height has_transparency is_current replaced_by_id replaced_by downloads_count updated_at category usage_rights current updated_since name category downloads_count updated_at (défaut : name)
GET /support-templates
brand:read
Les gabarits de supports proposés aux agences : type, format, validation exigée. Sans la définition des blocs, qui décrit les zones verrouillées.
id name description kind kind_label format medium output_format width height requires_approval legal_mentions_required is_active version fields_count updated_at kind format active updated_since name kind updated_at (défaut : name)
GET /support-generations
brand:read
Qui a produit quel support, quand, et où en est sa validation. C'est l'indicateur d'animation locale du réseau : une agence sans production est un signal.
id franchisee_id franchisee support_template_id template template_kind template_version status status_label output_format output_size downloads_count reviewed_at created_at updated_at franchisee template status since until updated_since created_at reviewed_at updated_at (défaut : -created_at)
GET /shop-products
shop:read
Le catalogue de la centrale d'achat du réseau.
id slug name brand_name display_name category category_label description price_ht vat_rate is_printable print_quantities available variants updated_at category updated_since sort_order name price_ht updated_at (défaut : sort_order)
GET /shop-orders
shop:read
Les commandes passées à la centrale, cloisonnées par agence.
id reference franchisee_id franchisee status status_label total_ht total_vat total_ttc is_invoiced invoice_number backorder_of placed_at shipped_at delivered_at lines updated_at franchisee status since until updated_since placed_at shipped_at total_ht updated_at (défaut : -placed_at)
Deux points d'entrée calculés, sous le périmètre ads:read. Ils
acceptent from, to (deux ans maximum) et
franchisee.
GET /acquisition/funnel
L'entonnoir par canal : lead → devis → accepté → facturé → payé, avec les taux de passage et le chiffre d'affaires encaissé. Par agence puis consolidé.
GET /acquisition/ads-summary
Coût, clics, impressions et conversions sur la période. Les taux (CTR, CPC, CPA, ROAS) sont recalculés sur la période demandée, jamais moyennés depuis les valeurs quotidiennes : une moyenne de moyennes serait fausse.
Toujours en JSON. Le code est fait pour être testé par une machine,
le message pour être lu par la personne qui débogue.
{ "error": { "code": "scope_missing", "message": "…", "required_scope": "leads:read" } }| Statut | Code | Signification |
|---|---|---|
401 |
key_missing |
Aucune clé dans l'en-tête Authorization. |
401 |
key_invalid |
Clé inconnue, ou secret erroné. |
401 |
key_expired |
La clé a passé sa date d'expiration. À renouveler. |
401 |
key_revoked |
La clé a été coupée depuis la console. Demandez pourquoi avant d'en redemander une. |
403 |
scope_missing |
Périmètre non accordé. Le périmètre attendu est dans error.required_scope. |
404 |
not_found |
Ressource inexistante, ou appartenant à un autre réseau. Les deux sont indiscernables, à dessein. |
405 |
read_only |
Tentative d'écriture. L'API ne sait que lire. |
422 |
filter_unknown |
Filtre inconnu. Les filtres acceptés sont listés dans la réponse. |
422 |
sort_unknown |
Tri impossible sur cette ressource. |
422 |
period_invalid |
Dates illisibles, ou début postérieur à la fin. |
422 |
period_too_wide |
Période supérieure à deux ans. |
429 |
rate_limited |
Quota dépassé. Attendre Retry-After secondes. |
Appelez l'API depuis votre serveur, pas depuis le navigateur du visiteur : une clé placée dans du JavaScript est lisible par tout le monde. Mettez le résultat en cache, les notes ne changent pas toutes les minutes.
<?php
$reponse = wp_remote_get('https://api.ldde.fr/v1/locations?with_reviews=1&sort=-total_reviews', [
'headers' => ['Authorization' => 'Bearer ' . MA_CLE_FRANCHIFY],
'timeout' => 8,
]);
$fiches = json_decode(wp_remote_retrieve_body($reponse), true)['data'] ?? [];
foreach ($fiches as $fiche) {
// $fiche['rating'] vaut null quand la fiche n'a pas encore d'avis :
// ce n'est PAS une note de zéro, ne l'affichez pas comme telle.
if ($fiche['has_reviews']) {
printf('%s : %s/5 (%d avis)', $fiche['name'], $fiche['rating'], $fiche['reviews_count']);
}
}
Un module WordPress prêt à l'emploi est fourni : ldde-reseau, avec le
raccourci [franchify_avis].
L'API répond quand on l'interroge. Le webhook fait l'inverse : il prévient. C'est ce qu'il faut pour réagir — relancer un avis négatif dans l'heure, pousser un lead vers un outil tiers — là où l'interrogation périodique arrive toujours trop tard, ou trop souvent pour rien.
Le franchiseur déclare une adresse de réception dans Paramètres → API, choisit ce qui doit lui être signalé, et reçoit un secret de signature.
POST https://votre-adresse/webhook
X-Franchify-Event: review.created
X-Franchify-Delivery: 8f2c… (identifiant unique de l'envoi)
X-Franchify-Timestamp: 1785000000
X-Franchify-Signature: sha256=…
{
"event": "review.created",
"occurred_at": "2026-07-31T14:22:10+02:00",
"resource": "reviews",
"data": { … } (exactement ce que GET /reviews/{id} renverrait)
}
Le contenu de data est produit par la même projection
que l'API de lecture. Un webhook ne peut donc pas livrer ce qu'un point d'entrée de
lecture garde à l'intérieur.
<?php
$corps = file_get_contents('php://input'); // le corps BRUT, non re-sérialisé
$horodatage = $_SERVER['HTTP_X_FRANCHIFY_TIMESTAMP'];
$recue = $_SERVER['HTTP_X_FRANCHIFY_SIGNATURE'];
$attendue = 'sha256=' . hash_hmac('sha256', $horodatage . '.' . $corps, VOTRE_SECRET);
if (! hash_equals($attendue, $recue)) {
http_response_code(401);
exit;
}
// Rejeter ce qui est trop vieux : une signature reste valable indéfiniment,
// c'est l'horodatage qui empêche de rejouer un envoi capté autrefois.
if (abs(time() - (int) $horodatage) > 300) {
http_response_code(401);
exit;
}
http_response_code(200); // accuser réception D'ABORD, traiter ensuite
Répondez 2xx dès réception, et traitez ensuite. Au-delà de huit
secondes l'envoi est compté en échec. Toute autre réponse déclenche une nouvelle
tentative, à intervalles qui s'espacent : 10 s, 1 min, 5 min, 30 min, 2 h. Après une
vingtaine d'échecs consécutifs, le point de réception est suspendu et le franchiseur
en est informé dans sa console.
Une relance peut aboutir alors que le premier envoi était bien arrivé. Servez-vous de
X-Franchify-Delivery, unique par envoi, pour ignorer un doublon.
review.created
Déclenché à l'arrivée d'un avis sur une fiche du réseau.
Charge utile : /reviews
lead.received
Données personnelles
Déclenché à la réception d'une demande entrante.
Charge utile : /leads
quotation.accepted
Déclenché quand un devis passe à l'état accepté.
Charge utile : /quotations
invoice.paid
Déclenché au passage d'une facture à « payée ».
Charge utile : /invoices
worksite.completed
Déclenché quand un chantier est marqué terminé.
Charge utile : /worksites
candidate.received
Données personnelles
Déclenché au dépôt d'une candidature de franchisé.
Charge utile : /candidates
candidate.signed
Données personnelles
Déclenché quand une candidature atteint le contrat signé.
Charge utile : /candidates
shop.order.shipped
Déclenché quand une commande à la centrale d'achat quitte le siège.
Charge utile : /shop-orders
La spécification OpenAPI est engendrée par le même catalogue que le moteur qui sert les requêtes : elle ne peut pas décrire une API qui n'existe plus.