API

Documentation Technique de l\u2019API

Vue d\u2019ensemble de l\u2019architecture d\u2019int\u00e9gration pour les sp\u00e9cialistes techniques. Protocole d\u2019interaction asynchrone, sp\u00e9cifications des formats de donn\u00e9es et m\u00e9canismes de fiabilit\u00e9.

Obtenir l\u2019Acc\u00e8s Politique de S\u00e9curit\u00e9

Principes Architecturaux

  • Traitement Asynchrone : utilisation du pattern Polling (202 Accepted) pour les sc\u00e9narios \u00e0 forte charge.
  • Idempotence : prise en charge de l\u2019en-t\u00eate Idempotency-Key pour garantir le traitement correct des nouvelles tentatives.
  • Typage Strict : validation des donn\u00e9es d\u2019entr\u00e9e (JSON Schema) au niveau de l\u2019API Gateway. Format principal du payload : { "text": "..." }.
  • Rate Limiting : quotas de requ\u00eates au niveau de l\u2019organisation (RPS/RPM) pour la protection de l\u2019infrastructure.
  • Politique Zero-Log : mode optionnel sans stockage persistant des donn\u00e9es (traitement en m\u00e9moire + TTL).

Note : l\u2019API est optimis\u00e9e pour le traitement de donn\u00e9es textuelles. Le traitement de fichiers binaires (PDF, images) n\u00e9cessite un OCR pr\u00e9alable c\u00f4t\u00e9 client ou l\u2019utilisation d\u2019un endpoint sp\u00e9cialis\u00e9 (disponible en version \u00e9tendue).

Sp\u00e9cification et Acc\u00e8s

La documentation technique compl\u00e8te, comprenant les descriptions des endpoints, les mod\u00e8les de donn\u00e9es et les codes d\u2019erreur, est fournie aux partenaires apr\u00e8s la signature du contrat.

  • Authentification : authentification par API Key / Bearer Token.
  • Versionnage : prise en charge du versionnage de l\u2019API pour garantir la compatibilit\u00e9 ascendante.
  • Gestion des Erreurs : codes d\u2019erreur standardis\u00e9s et messages d\u00e9taill\u00e9s pour le d\u00e9bogage.
  • SDK et Exemples : exemples d\u2019int\u00e9gration pour les langages de programmation populaires (Python, JavaScript/TypeScript, Go).

Pour obtenir l\u2019acc\u00e8s \u00e0 l\u2019API et \u00e0 la documentation compl\u00e8te, veuillez envoyer une demande.

Flux de Travail

  1. Initier le Traitement : Envoi d\u2019une requ\u00eate POST avec le payload et l\u2019en-t\u00eate Idempotency-Key.
  2. Accusé de R\u00e9ception : R\u00e9ception de la r\u00e9ponse 202 Accepted avec task_id.
  3. Interrogation : V\u00e9rification p\u00e9riodique du statut de la t\u00e2che par task_id (l\u2019intervalle recommand\u00e9 et la strat\u00e9gie de backoff sont sp\u00e9cifi\u00e9s dans la documentation).
  4. R\u00e9cup\u00e9rer le R\u00e9sultat : R\u00e9ception du r\u00e9sultat du traitement lorsque le statut est COMPLETED.

Dans le cadre du projet pilote, les prompts et mod\u00e8les de g\u00e9n\u00e9ration sont configur\u00e9s pour vos processus m\u00e9tier sp\u00e9cifiques.

Discuter de l\u2019Int\u00e9gration