Une API publique versionnée, en préparation.
En préparation
Notre API v1 exposera les ressources principales du studio sous une surface stable, versionnée et documentée. Aucune partie de cette API n’est en service au public à la date de cette page. Les contours décrits ici reflètent l’intention de contrat — pour que vous puissiez, comme éditeur CRM, suite notariale ou système d’évaluation, planifier votre intégration.
Principes
- Versionnée — préfixe
/v1/..., journal de changements public, pas de bris silencieux pour les clients qui épinglent une version. - Authentifiée — clés rotatives par organisation, scopes par ressource. La création de clés suivra le flux pilote qu’on annoncera.
- Bornée — quotas et limites publiés, idempotence sur les écritures dès le gel du contrat.
- Auditée — journal d’audit conservé selon les engagements de la page Sécurité.
- Régionalisée — traitement et stockage des données applicatives au Canada, dans la continuité de la Loi 25.
Ressources prévues (v1)
En préparation
| Ressource | Méthode | Forme | Crédits |
|---|---|---|---|
| Propriété (lecture par identifiant fonciq) | GET /v1/proprietes/{id} | Fiche structurée | À venir · objectif : 1 crédit fonciq par lecture fraîche |
| Recherche (adresse → lots) | POST /v1/recherche | Résolution adresse → identifiants | À venir · objectif : gratuite ou comprise dans la lecture suivante |
| Cahier de preuve PDF | POST /v1/proprietes/{id}/cahier-preuve | PDF horodaté SHA-256 | À venir · objectif : 1 crédit fonciq |
| Webhook mutation / 45 j | POST /v1/abonnements | Événements push | À venir · objectif : sans crédit additionnel pour les abonnements ouverts |
| Pronotaire / Para-Maître (export) | POST /v1/proprietes/{id}/exports/{format} | Fichier connecteur | À venir · objectif : 1 crédit fonciq |
Cette table est un engagement de contour, pas une promesse de date.
Modèle d’erreur prévu
- Corps JSON structuré avec identifiants prévus :
{ code, message, request_id, retry_after ? }. - Codes HTTP conventionnels ; les messages resteront non nominatifs (pas de fuite de PII dans les chaînes d’erreur).
- Alignement sur les pratiques de traçabilité côté support (request identifiant pour corrélation avec le journal d’audit).
Limites conformité
- Respect de la Loi 25 et des engagements publiés — voir Confidentialité.
- Hébergement et traitement au Canada pour les données couvertes.
- Distinction maintenue entre lecture par le moteur Greffe Fonciq (GREF) — Générateur de Reconstitution d’Extraits Fonciers — et lecture attestée par les pairs lorsque ces niveaux seront exposés séparément.
Pilote partenaire
Écrire pour un pilote API →Positionnez votre organisation comme intégrateur CRM, suite notariale ou moteur d’évaluation. Décrivez le volume attendu, vos flux batch ou temps réel, et vos contraintes légales. Le pilote initial restera volontairement étroit — quelques organisations, périmètre cadré — pour garder la qualité de réponse et la conformité.
De votre côté : un point de contact technique, le respect des conditions d’essai et la non-diffusion des clés. De notre côté : documentation des ruptures de compatibilité, canal support dédié pendant le pilote, et aucune facturation des crédits pilote au-delà de ce qui sera écrit dans l’accord signé.
Aucune clé en libre-service tant que le flux de provisioning interne n’est pas terminé. Le point d’entrée reste le courriel pilote ci-dessous.
Écrire pour un pilote API →Questions fréquentes
- Quand l’API sera-t-elle disponible ?
- Aucune date publique annoncée ici. Le calage dépend d’au moins deux partenaires pilotes signés, de la validation juridique Loi 25 et des revues de sécurité. Cette page documente l’intention de contrat, rien de plus.
- Pourrai-je facturer mes propres clients via fonciq ?
- La revente en marque blanche aux consommateurs finaux n’est pas prévue dans le contour de la v1. L’accès visé est B2B direct, entre fonciq et l’organisation intégratrice.
- Y aura-t-il des webhooks ?
- Oui, le contour prévoit des abonnements et des événements push. La liste et le schéma seront publiés avec la documentation à la sortie. Pas de date promise ici.
- Quels sont les crédits pour un appel API ?
- À l’alignement avec le studio : une lecture fraîche de fiche = 1 crédit fonciq ; une recherche = gratuite ou incluse dans la lecture suivante, selon le barème publié à la livraison.
- Comment me préparer dès maintenant ?
- Utilisez le studio sur l’environnement réel pour cartographier les champs dont votre produit a besoin, puis comparez à la table des ressources prévues ci-dessous.