Aller au contenu

Manuel d’intégration – APIs Métier / Insight

Ce document a pour objectif de rendre autonome un éditeur tiers souhaitant intégrer les API **Insight ** concernant les commandes et les DIE.

1. Ouverture du chiffrage

Ce scénario décrit la manière dont le logiciel métier interroge Insight pour récupérer les commandes, puis crée un chiffrage à partir d’un devis importé.

sequenceDiagram
    title Ouverture du chiffrage dans le logiciel métier

    participant U as Utilisateur
    participant L as Logiciel métier
    participant I as API Insight

    %% Affichage des commandes
    U->>L: Afficher les commandes
    L->>I: Demande de la liste des commandes en cours<br/>(POST /me/organization/die-orders/search)
    I-->>L: Retour de la liste des commandes

    %% Import d’un devis
    U->>L: Demande d'import d'un devis
    L->>I: Demande du devis pour créer l'opportunité<br/>(GET /me/organization/die-orders/${dieOrderId}/cost-study)
    I-->>L: Retour du devis et des lignes de chiffrage

    %% Création interne dans le logiciel métier
    L-->>L: Création de l'opportunité
    L-->>L: Création de la feuille de chiffrage

    %% Mise à disposition à l'utilisateur
    L-->>U: Mise à disposition du chiffrage

2. Téléchargement des exports

Ce scénario décrit la demande d’export, la génération des documents, puis la récupération et ouverture des fichiers.

sequenceDiagram
    title Téléchargement des exports

    participant U as Utilisateur logiciel métier
    participant L as Logiciel métier
    participant I as API Insight

    %% Consultation du devis
    U->>L: Rechercher un devis existant
    L-->>L: Affichage du devis déjà importé

    %% Complétion du devis
    U->>L: Complétion du devis

    %% Demande d’export
    U->>L: Demande de l'export de documents originaux complétés
    L->>I: Envoi des valeurs saisies par l'utilisateur au service d'export des documents<br/>(POST /dies/{dieId}/reports)
    I-->>L: Retour OK
    L-->>U: Message de prise en compte de la demande

    %% Liste des exports disponibles
    U->>L: Demande la liste des exports disponibles pour le devis en cours
    L->>I: Demande de la liste des exports du devis<br/>(GET /dies/{dieId}/reports)
    I-->>L: Retour de tous les exports (URLs de téléchargement et statuts)
    L-->>U: Affichage de la liste

    %% Téléchargement et ouverture
    U->>L: Sélection d'un export
    L-->>L: Téléchargement d'un ZIP avec tous les documents dans un répertoire de l'utilisateur
    L-->>L: Ouverture de tous les documents à l'utilisateur