API reference

Available

The function described exists and is tested; the page also states what it does not do.

Generated at build time from the platform's OpenAPI contract. Nothing here is written by hand: an operation missing from the contract does not appear here.

Contract: NEXCLARA API
Contract version: 0.4.0
OpenAPI version: 3.1.0
Path prefix: /api/v1
Contract SHA-256 fingerprint: 366e817dde1241feadfc1bb62e082b025616ff20fb4db70e47b4b2c9b944d508

Contract

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

Operation families

health
Sondes techniques de vivacite et d'aptitude au trafic.
3 operations
identity
Connexion, second facteur, profil, invitations.
8 operations
administration
Module ADMIN de l'institution. Chaque operation exige ses permissions.
33 operations
integration
Verification d'un identifiant machine.
1 operation
policies
Politiques de decision : versions, parametres, simulation, soumission, approbation, archivage.
11 operations
link
LINK : contrat de donnees, gabarit, depot de fichier CSV, pre-validation, import confirme, provenance et qualite.
16 operations
knowledge
SAGE, recherche sourcee : passages autorises de la documentation, cites (titre, lien, section, version, fraicheur). Aucune reponse generee : aucun modele de langage n'est employe.
7 operations
pilot
Parcours du pilote : etapes calculees a partir des faits des modules, jalons, prochaine action par permission, attestation des pieces du cadre.
3 operations
applications
Dossiers de credit : saisie, soumission au moteur, evaluation, explication, reconstitution.
14 operations
account
The contract does not describe this family.
11 operations
trust
The contract does not describe this family.
18 operations
historical-simulation
The contract does not describe this family.
8 operations
modules
The contract does not describe this family.
3 operations

Schemas (204)

Authentication

The contract does not yet declare any security scheme. Protected operations expect a bearer token in the Authorization header: see the dedicated page.

Authentication: tokens and credentials

Errors

The contract describes 422 responses with the framework's generic schema (HTTPValidationError). The actual error response follows the platform's error protocol.

Error protocol

Pagination

The following operations declare offset pagination, with the limit and offset parameters.

Idempotency

The following operations carry a client-chosen idempotency key in the request body: replaying the same key returns the same result.