Guide de migration vers l’API Inovaclic versionnée

Pourquoi migrer ?

Uniformisation des formats.
Débits optimisés : fréquences d’appel augmentées jusqu’à +200 % selon les points de terminaisons.
Charges plus conséquentes : taille maximale des requêtes portée à 65 Mo (+30 %).
Futures extensions déjà intégrées : versioning clair (/v1/), authentification identique, rétro‑compatibilité totale.
Aucun impact sur vos clés API ni sur vos workflows de sécurité.
Logique et compréhension plus simple du workflow
Mise en place d'une collection Postman pour vos tests : Postman Collection
Obtenir les nouveaux champs extraits

Vue d’ensemble des changements

Lecture Automatique des Bilans (LAB): Ancien → Nouveau

/Inovaclic/Lab/External/extract/live → /v1/lab/processes/live
- application/json → multipart/form-data
- fréq. appel 1/5 s → 1/3 s
- taille maximale 50 Mo → 65 Mo
/Inovaclic/Lab/External/extract/batch → /v1/lab/processes/batch
- application/json → multipart/form-data
- fréq. appel 1/10 s → 1/8 s
- taille maximale 50 Mo → 65 Mo
/Inovaclic/Lab/External/extract/{process_id}/status → /v1/lab/processes/{process_id}/status
- fréq. appel 1/s → 3/s
- Result (uri) supprimé (= /v1/lab/processes/{process_id})
- liasses[].Result (uri) supprimé (= /v1/lab/liasses/{liasse_id})
- liasses[].ExtractionStatus :
  - InProgress
  - Failed
  - Rejected
  - Canceled
  - Succeeded
/Inovaclic/Lab/External/extract/{process_id}/data → /v1/lab/processes/{process_id}
- fréq. appel 1/5 s → 1/3 s
- Identique à la réponse envoyée sur le endpoint de completion
- [].LiasseProfil → liasses[].documentInfos.profile
- [].LiasseMillesime → liasses[].documentInfos.millesime
- [].CancellationStatus remplacé par liasses[].extractionStatus == Canceled
- [].RejectionStatus remplacé par liasses[].extractionStatus == Rejected
- [].ValidationStatus supprimé (redondant avec ExtractionStatus)
- [].DetailsStatus supprimé (redondant avec ExtractionStatus)
- [].TreatmentStatus supprimé (redondant avec ExtractionStatus)
- [].type → liasses[].documentInfos.type
- [].hasDetails → liasses[].documentInfos.hasDetails
- [].detailsAreCodified→ liasses[].documentInfos.hasCodifiedDetails
- [].hasDetails→ liasses[].documentInfos.hasDetails
- [].ErrorMessage → liasses[].statusMessage (voir StatusDetails pour plus de détails)
- [].ErrorDetails → liasses[]. statusDetails
- [].ExtractionStatus :
  - InProgress
  - Failed
  - Rejected
  - Canceled
  - Succeeded
/Inovaclic/Liasse/External/{liasse_id} → /v1/lab/liasses/{liasse_id}
- fréq. appel 1/5 s → 5/5 s
- LiasseProfil → documentInfos.profile
- LiasseMillesime → documentInfos.millesime
- CancellationStatus remplacé par extractionStatus == Canceled
- RejectionStatus remplacé par extractionStatus == Rejected
- ValidationStatus supprimé (redondant avec ExtractionStatus)
- DetailsStatus supprimé (redondant avec ExtractionStatus)
- TreatmentStatus supprimé (redondant avec ExtractionStatus)
- type → documentInfos.type
- hasDetails → documentInfos.hasDetails
- detailsAreCodified→ documentInfos.hasCodifiedDetails
- hasDetails→ documentInfos.hasDetails
- ErrorMessage → statusMessage (voir StatusDetails pour plus de détails)
- ErrorDetails → statusDetails
- ExtractionStatus :
  - InProgress
  - Failed
  - Rejected
  - Canceled
  - Succeeded

Relevés bancaires (RDC): Ancien → Nouveau

/Inovaclic/rb/External/extract/live → /v1/rdc/processes/live
- application/json → multipart/form-data
- fréq. appel 1/10 s → 1/5 s
- taille maximale 50 Mo → 65 Mo
- Nombre de page par document 120 → 200
/Inovaclic/rb/External/extract/batch → /v1/rdc/processes/batch
- application/json → multipart/form-data
- fréq. appel 1/10 s → 1/5 s
- taille maximale 50 Mo → 65 Mo
- Nombre de page par document 120 → 200
/Inovaclic/rb/External/extract/{process_id}/status → /v1/rdc/processes/{process_id}/status
- fréq. appel 1/s → 2/s
- ExtractionStatus :
  - InProgress
  - Failed
  - Rejected
  - Canceled
  - Succeeded
/Inovaclic/rb/External/extract/{process_id}/data → /v1/rdc/processes/{process_id}
- fréq. appel 1/5 s → 1/4 s
- [].ExtractionStatus :
  - InProgress
  - Failed
  - Rejected
  - Canceled
  - Succeeded
/Inovaclic/rb/External/extract/{rb_id}/data → /v1/rdc/rbs/{rb_id}
- fréq. appel 1/5 s → 1/4 s
- ExtractionStatus :
  - InProgress
  - Failed
  - Rejected
  - Canceled
  - Succeeded

Tous les nouveaux endpoints sont sous /v1/ pour un versioning explicite et durable.

Étapes de migration

Mettre à jour les URLs : remplacez simplement l’ancien chemin par le nouveau ; la structure des paramètres (process_id, liasse_id, rb_id) reste inchangée.
Passez au multipart/form-data pour les uploads : pour /live et /batch, un exemple complet est disponible sur la collection Postman Inovaclic.
Dans le cadre de l'api LAB:
- Adaptez le format JSON des réponses sur les webhooks : renommez les champs de PascalCase en camelCase (ex. ProcessId ➜ processId) si votre déserialiseur est sensible à la casse.
- Adaptez le nouveau format de résponse (identique à /v1/lab/processes/{process_id})
Adaptez les workflows aux nouvelles valeurs d'ExtractionStatus.
- InProgress: en cours de traitement
- Canceled: annulé/timeout
- Rejected: rejeté fonctionnellement (pages manquantes, données fausses, mauvais imprimé etc.)
- Failed: erreur technique Inovaclic
- Succeeded: terminé avec succès (il peut y avoir un message d'information en complément dans le champs statusMessage)
Optimisez vos appels : profitez des fréquences accrues, ajustez votre logique de pagination (RDC) et utilisez la nouvelle limite de 65 Mo pour diminuer le nombre de fragments.

FAQ

Dois‑je modifier mes clés API ? Non, l’authentification reste identique.
Y a‑t‑il des changements de quotas globaux ? Non, seuls les plafonds par endpoint évoluent (voir listes ci‑dessus).
Quand les anciens points de terminaisons seront supprimés ? 1 septembre 2027
Combien de temps dois-je allouer pour migrer l'usage de l'Api ? En dehors de vos éventuelles contraintes techniques et fonctionnelles internes, la migration ne prend généralement que quelques minutes à quelques heures d'un point de vue purement technique.
Oú puis-je trouver des exemples d'intégrations ? Des exemples complets sont disponibles sur la collection Postman Inovaclic dans tous les langages populaires.
En cas de questions, qui dois-je contacter ? [email protected]