fonciqAPI
Tâches

Lire le PDF d'un document

Portée `jobs:read`. Renvoie le PDF d'un index ou d'un acte produit pour l'organisation. Le corps est `application/pdf`. Pour un index, ce PDF est toujours renvoyé et il fait foi, que des lignes aient été lues ou non. Une liste de lignes vide ne le remplace pas. Les lignes se lisent sur `GET /v1/documents/{id}/entries`, sur la tâche et sur la fiche.

GET
/v1/documents/{id}

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 de chemin

idstring

Identifiant du PDF. C'est le source_document_id d'une ligne, ou l'identifiant porté par document_url.

Corps de la réponse

application/pdf

application/json

application/json

application/json

curl -X GET "https://api.fonciq.ca/v1/documents/string"
"string"
{
  "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": "rate_limited",
    "message": "Trop de requêtes pour cette clé.",
    "request_id": "req_01HZX"
  }
}

Commander un index POST

Portée `registre:write`. En-tête `Idempotency-Key` obligatoire, conservé 24 heures. Une reprise avec la même clé renvoie la réponse enregistrée pour cette clé. La consultation s'exécute sur le compte du Registre de l'organisation. Sans `account_id`, le compte par défaut est utilisé. Avec `account_id`, la requête est épinglée à ce compte. Chaque index livré débite 99 cents sur une clé réelle. Les frais du Registre, 150 cents, s'appliquent lorsque le Registre est consulté. L'index consulte toujours le Registre. Ces 150 cents sont facturés par le Registre au titulaire. Ils ne figurent pas comme un débit Fonciq. `documents` vaut `index`. La réponse contient `job_id`. La tâche entre dans la file du compte. Le plafond est de 540 index par jour pour ce compte.

Lire les lignes d'un index GET

Portée `jobs:read`. Lecture directe des lignes conservées pour cet index. Même objet qu'une tâche terminée : `parse`, `unparsed_retained` et `entries`. JSON par défaut. `format=csv` ou `Accept: text/csv` renvoie le CSV. `format` l'emporte. Toute autre valeur reçoit `400` et le code `invalid_request`. `404` lorsque le document n'est pas un index produit pour l'organisation. Le PDF de cet index reste la source, même si `entries` est vide. `parse.confidence` et la confiance de chaque ligne valent `unscored`. `needs_review` est nul sur une ligne structurée. `unparsed_retained` vaut `false` et `unparsed` est omis. Aucune ligne n'est inventée. Un tirage sans PDF n'a pas de lignes.