fonciqAPI
Lots groupés

Soumettre un lot groupé

Portée `batches:write`. En-tête `Idempotency-Key` obligatoire, conservé 24 heures. Au plus 500 lots par requête. Corps JSON `{ "lots": ["…"] }` ou CSV `text/csv` avec une colonne `lot` ou `matricule`. Un index débite 99 cents par lot sur une clé réelle. Ce débit ne figure pas dans `GET /v1/billing`. Sans `account_id`, le lot groupé est réparti en parallèle sur les comptes du Registre actifs de l'organisation. Avec `account_id`, chaque lot est épinglé à ce compte. Chaque compte conserve son plafond de 540 index par jour. Les consultations demandées passent par la même file qu'une requête unitaire. Les frais du Registre, 150 cents, s'appliquent lorsque le Registre est consulté. L'index consulte toujours le Registre. Le Registre facture le titulaire du compte qui a exécuté la consultation.

POST
/v1/batches

Autorisation

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

Corps de la requête

lotsarray<string>
Éléments1 <= éléments <= 500
documents?array<string>

Omis, aucun document n'est commandé au Registre.

account_id?string

Présent, tout le lot groupé est épinglé à ce compte. Omis, le travail est réparti en parallèle sur les comptes actifs.

Corps de la réponse

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.fonciq.ca/v1/batches" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "lots": [      "1234567",      "7654321"    ],    "documents": [      "index"    ]  }'
{
  "job_id": "job_batch_01HZX",
  "account_id": null
}
{
  "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": "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"
  }
}

Lire le résultat d'une tâche GET

Portée `jobs:read`. Lignes d'index de la tâche. JSON par défaut : `indexes`, un bloc par lot. Une tâche unitaire a un seul élément. Un lot groupé en a un par lot. `format=csv` ou `Accept: text/csv` aplatit les lignes structurées en CSV. `format` l'emporte. Toute autre valeur reçoit `400` et le code `invalid_request`. Colonnes, dans cet ordre : `lot`, `matricule`, `inscription`, `date`, `nature`, `parties`, `document_url`, `read_method`, `confidence`, `needs_review`, `page_status`. Une rangée par ligne structurée. `parties` est `Rôle: Nom`, joint par `; `. `matricule` vient du rôle du MAMH pour ce lot. La cellule est vide sinon. `document_url` est le PDF d'index, qui fait foi. `confidence` vaut `unscored`. `needs_review` est vide sur une ligne structurée, comme `null` en JSON. `read_method` et `page_status` sont vides : ces valeurs sont prévues. Les radiations, les remarques, `seqnt_prodt`, `portal_href` et `raw_text` restent dans le JSON. Tant que `unparsed_retained` vaut `false`, le CSV ne contient que les lignes structurées. Les rangées écartées ne sont pas écrites comme des lignes vides.

Lire le journal estimé du Registre par compte GET

Portée `billing:read`. Frais du Registre foncier imputés à chaque compte connecté, pour une période. Ce n'est pas la facturation de plateforme de Fonciq. Aucun relevé du portail n'est lu. `source` vaut `estimate`. Les lignes sont le journal Fonciq des tirages. Le compte est `id`. La même valeur est répétée dans `account_id`. `statement.available` est faux, `statement.balance_cents` est nul et `statement.source` vaut `unavailable`. Le détail par document est dans `GET /v1/billing/usage`.