fonciqAPI
Surveillances

Créer une surveillance

Portée `watches:write`. En-tête `Idempotency-Key` obligatoire, conservé 24 heures. Le Registre foncier n'offre pas de flux poussé. Une surveillance est une revérification planifiée, comparée à un instantané de référence pris à la création. Sans `account_id`, elle est placée sur le compte par défaut. Avec `account_id`, elle est épinglée à ce compte. Elle consomme la capacité quotidienne d'index de ce compte (plafond 540, dont 180 réservés aux appels à la demande). Créer la surveillance interroge les rôles d'évaluation foncière des municipalités du Québec, l'un des jeux de données publics intégrés aux Données Fonciq. `cadence` vaut `weekly` (défaut) ou `daily`. Créer la surveillance ne débite pas Fonciq. Chaque index consulté ensuite débite 99 cents sur une clé réelle et 150 cents au Registre, parce que l'index consulte toujours le Registre. Les frais du Registre s'appliquent lorsque le Registre est consulté. Ce débit de 99 cents n'est pas renvoyé ici. Plafond d’organisation : 25 surveillances actives. Au-delà, la réponse est `409` et le code `watch_cap_reached`. Il n’y a pas de plafond quotidien d’index de surveillance par organisation. Chaque compte garde le sien. `cadence` est `weekly` ou `daily`, pas une cadence mensuelle. La pause, la suppression, l’historique et le renvoi manuel se font dans le tableau de bord.

POST
/v1/watches
AuthorizationBearer <token>

Clé d'API de l'organisation. Le secret n'est montré qu'une fois. Le préfixe affichable d'une clé d'essai est fq_test_. Le hachage SHA-256 est la seule forme conservée. Le panneau d'essai de cette documentation n'envoie qu'une clé fq_test_ et n'effectue aucun débit.

Dans : en-tête

Paramètres d'en-tête

Idempotency-Keystring

Clé d'idempotence conservée 24 heures. La même clé et le même corps renvoient la réponse enregistrée.

Longueur8 <= longueur <= 255
lotstring
cadence?string

weekly est le défaut. daily est l'option plus fréquente. Le prix de plateforme Fonciq n'est pas renvoyé par l'API de facturation.

Défaut"weekly"
Valeurs"weekly" | "daily"
urlstring

URL qui recevra les avis signés.

Formaturi
account_id?string

Compte du Registre dont la surveillance consommera la capacité. Omis, le compte par défaut est utilisé.

Corps de la réponse

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.fonciq.ca/v1/watches" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "lot": "1234567",    "cadence": "weekly",    "url": "https://exemple.com/hooks/fonciq"  }'
{
  "id": "watch_01HZX",
  "lot": "1234567",
  "cadence": "weekly",
  "account_id": "rfa_exemple",
  "url": "https://exemple.com/hooks/fonciq",
  "status": "active"
}
{
  "error": {
    "code": "invalid_request",
    "message": "Indiquer une adresse ou un matricule.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Clé d'API refusée.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "account_not_found",
    "message": "Ce compte du Registre n'appartient pas à l'organisation.",
    "request_id": "req_01HZX"
  }
}

{
  "error": {
    "code": "watch_cap_reached",
    "message": "Le plafond de surveillances actives est atteint.",
    "request_id": "req_01HZX"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Trop de requêtes pour cette clé.",
    "request_id": "req_01HZX"
  }
}

Résoudre une adresse ou un matricule GET

Portée `lots:read`. Cette lecture interroge les rôles d'évaluation foncière des municipalités du Québec, l'un des jeux de données publics intégrés aux Données Fonciq. Elle n'entraîne pas de frais de document. Fournir `address` ou `matricule`. La réponse énumère le lot, le cadastre, le matricule et indique si le rôle corrobore le lot.

Avis envoyé à l'URL de la surveillance POST

Fonciq appelle l'URL enregistrée sur la surveillance lorsque l'écart avec l'instantané de référence n'est pas vide. Un écart vide n'envoie rien. En-tête `Fonciq-Signature: t=<unix>,v1=<hex>`. `v1` est le HMAC-SHA256 de `{t}.{corps brut}` signé avec le secret du point de terminaison, montré une seule fois. Le récepteur rejette un `t` éloigné de plus de cinq minutes. Types : `index.inscription_added`, `acte.added`, `cadastre.changed`, `assessment.changed`. `document_url` est nul pour un changement de cadastre ou d'évaluation sans PDF du Registre. Tentatives : envoi immédiat, puis environ 24 h, 48 h et 72 h (quatre essais). L'état passe ensuite à `failed`. Le renvoi manuel, depuis le tableau de bord, est un nouvel essai. Une relecture humaine des index manuscrits anciens est prévue. Lorsqu'elle sera offerte, l'avis signé `index.review_completed` portera l'identifiant de l'avis, l'identifiant de la tâche et `document_url`. Le PDF reste la source. Ce palier n'a pas de prix publié et pas de délai publié. Il n'est pas envoyé aujourd'hui. L'avis concerne le compte du Registre sur lequel la surveillance est placée. Cette vérification a consommé la capacité de ce compte.