Aller au contenu principal
NEXCLARADocumentation

Référence de l'API

Disponible

La fonction décrite existe et est testée ; la page dit aussi ce qu'elle ne fait pas.

Générée à la construction depuis le contrat OpenAPI de la plateforme. Rien n'y est écrit à la main : une opération absente du contrat n'apparaît pas ici.

Contrat
NEXCLARA API
Version du contrat
0.4.0
Version OpenAPI
3.1.0
Préfixe des chemins
/api/v1
Empreinte SHA-256 du contrat
366e817dde1241feadfc1bb62e082b025616ff20fb4db70e47b4b2c9b944d508
Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

Familles d'opérations

  • health

    Sondes techniques de vivacite et d'aptitude au trafic.

    3 opérations

  • identity

    Connexion, second facteur, profil, invitations.

    8 opérations

  • administration

    Module ADMIN de l'institution. Chaque operation exige ses permissions.

    33 opérations

  • integration

    Verification d'un identifiant machine.

    1 opération

  • policies

    Politiques de decision : versions, parametres, simulation, soumission, approbation, archivage.

    11 opérations

  • link

    LINK : contrat de donnees, gabarit, depot de fichier CSV, pre-validation, import confirme, provenance et qualite.

    16 opérations

  • 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 opérations

  • pilot

    Parcours du pilote : etapes calculees a partir des faits des modules, jalons, prochaine action par permission, attestation des pieces du cadre.

    3 opérations

  • applications

    Dossiers de credit : saisie, soumission au moteur, evaluation, explication, reconstitution.

    14 opérations

  • account

    Le contrat ne décrit pas cette famille.

    11 opérations

  • trust

    Le contrat ne décrit pas cette famille.

    18 opérations

  • historical-simulation

    Le contrat ne décrit pas cette famille.

    8 opérations

  • modules

    Le contrat ne décrit pas cette famille.

    3 opérations

Schémas (204)

Authentification

Le contrat ne déclare encore aucun schéma de sécurité. Les opérations protégées attendent un jeton porteur dans l'en-tête Authorization : voir la page dédiée.

Authentification : jetons et identifiants

Erreurs

Le contrat décrit les réponses 422 par le schéma générique du cadre (HTTPValidationError). La réponse effective d'une erreur suit le protocole d'erreur de la plateforme.

Protocole d'erreur

Pagination

Les opérations suivantes déclarent une pagination par décalage, avec les paramètres limit et offset.

Idempotence

Les opérations suivantes portent une clé d'idempotence choisie par le client dans le corps de la requête : la même clé rejouée rend le même résultat.