Utilisation de l'API REST Liciweb

 

Cette documentation énumère les différentes méthodes mises à disposition des utilisateurs de Liciweb pour consommer l'API REST et ainsi interagir avec leurs données présentes sur le cloud.

L'utilisation de cette fonctionnalité est soumise à une souscription spécifique à évoquer avec notre service client.

Plateforme de test des différentes méthodes

Afin de pouvoir tester les différentes méthodes disponibles de l'API, un environnement de test de type Swagger a été mis a disposition à cette adresse :

https://demo.liciweb.com/rest/tester

 

Authentification

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/token/generate

Variables:

  • username (chaîne de caractères)

  • password (chaîne de caractères)

Description:

Méthode permettant de récupérer le token d'authentification valable 24 heures, nécessaire pour utiliser les autres méthodes. Les identifiants sont ceux des utilisateurs du backoffice et doivent disposer des droits backoffice minimum.

En cas de succès la méthode retournera la valeur success à true ainsi que le token.

Exemple de réponse :

En cas d'erreur:

 

Listing des dossiers à télécharger

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/listing

Headers

Authorization : Bearer {{token}}

Variables:

  • token (chaîne de caractères) *

  • date (chaîne de caractères) (YYYY-MM-DD)

 

Description:

Cette API vous permet de lister les dossiers à télécharger sur votre compte cloud, ainsi que d'effectuer une recherche dans cette base en fonction d'une date de rendez-vous définie.

La réponse renvoie une liste d'id dossiers disponibles à télécharger, limitée à 500 entrés et triée par date de rendez-vous.

Exemple de réponse :

 

Comptage du nombre de dossier à télécharger

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/count-to-download

Headers

Authorization : Bearer {{token}}

Variables:

  • token (chaîne de caractères) *

  • date (chaîne de caractères)

Description:

Cette méthode permet de compter le nombre de dossier à télécharger

 

 

Mise à jour de l'état de téléchargement d'un dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/update-download-state

Headers

Authorization : Bearer {{token}}

Variables:

  • token (chaîne de caractères) *

  • id (entier)

  • forceDownload (booléen)

Description:

Cette méthode permet de mettre à jour l'état de téléchargement d'un dossier afin qu'il n'apparaisse plus dans la liste de téléchargement. En initialisant la variable forceDownload à 1 vous pouvez repasser le dossier dans la liste d'attente de téléchargement.

 

Téléchargement d'un dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/download

Headers

Authorization : Bearer {{token}}

Variables:

  • token (chaîne de caractères) *

  • id (entier)

Description:

Cette méthode permet de télécharger le fichier ZIP d'un dossier spécifique. Le jeton d'authentification est requis pour l'accès, et l'identifiant du dossier doit être spécifié.

 

Recherche avancée de dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/search

Headers

Authorization : Bearer {{token}}

Variables:

  • token (chaîne de caractères) *

  • date (YYYY-MM-DD) (Date de RDV)

  • download (entier)

  • search (chaîne de caractères)

  • page (entier)

  • download (boolean)

Description:

Cette méthode permet d'effectuer des recherches de dossiers présents dans la base de données en fonction de leur état, nom et date de rendez-vous. Le nombre de résultats est limité à 500 lignes, mais l'intégralité de la recherche peut être parcourue grâce au paramètre de pagination page. Un jeton d'authentification est requis pour accéder à cette méthode. En initialisant la variable download a 1 la fonction retournera uniquement les dossiers à télécharger, le cas contraire elle listera tous les dossiers sans distinction d'état de téléchargement.

Exemple de réponse :

 

Téléchargement en fonction du numéro de dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/download-by-num-dossier

Headers

Authorization : Bearer {{token}}

Variables:

  • token (chaîne de caractères) *

  • numDossier (chaîne de caractères)

Description:

Cette méthode permet de télécharger le fichier ZIP d'un dossier spécifique en fonction de son numéro de dossiers.

 

Récupération des informations d'un dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/get-info

Headers

Authorization : Bearer {{token}}

Variables:

  • token (chaîne de caractères) *

  • id (entier)

  • numDossier (chaîne de caractères)

Description:

Cette méthode permet de récupérer l'intégralité des valeurs d'un dossier recherché par son identifiant de base de données, qui peut être obtenu via la méthode de listing des dossiers ou en utilisant un numéro de dossier.

 

Ajout et édition d'un dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/add-edit

Headers

Authorization : Bearer {{token}}

Variables:

  • id (chaîne de caractères) - numDossier (chaîne de caractères)
  • dossierEtat (chaîne de caractères) : 'Devis', 'Devis confirmé', 'Diag annulé', "Diag en attente", "Facturation en cours", 'Diag en cours', 'Administratif à terminer', "Paiement en attente", 'Rapport en édition', 'Rapport envoyé', 'Rapport imprimé', 'RDV Pris', 'Rdv à reprogrammer', 'Dossier clos', 'Mission annulée'
  • dordreTypeAutre (booléen) : '0', '1'
  • dossierClot (booléen) : '0', '1'
  • dossierUrgent (booléen) : '0', '1'
  • arAmiante (booléen) : '0', '1'
  • noRelance (booléen) : '0', '1'
  • dordreTypeProp (booléen) : '0', '1'
  • dordreTypeApporteur (booléen) : '0', '1'
  • dordreTypeLocataire (booléen) : '0', '1'
  • dordreTypeNotaire (booléen) : '0', '1'
  • typeDoneurOrdre (chaîne de caractères) : 'Propriétaire' ,'Apporteur', 'Locataire', 'Notaire', 'Autre'
  • dordreEntete (chaîne de caractères)
  • dordreNom (chaîne de caractères)
  • dordreCompany (chaîne de caractères)
  • dordreAdresse (chaîne de caractères)
  • dordreCp (chaîne de caractères)
  • dordreVille (chaîne de caractères)
  • dordreCountry (chaîne de caractères)
  • dordreTel (chaîne de caractères)
  • dordreFax (chaîne de caractères)
  • dordreMail (chaîne de caractères)
  • proprietaireEntete (chaîne de caractères)
  • proprietaireNom (chaîne de caractères)
  • proprietaireCompany (chaîne de caractères)
  • proprietaireAdresse (chaîne de caractères)
  • proprietaireCp (chaîne de caractères)
  • proprietaireVille (chaîne de caractères)
  • proprietaireCountry (chaîne de caractères)
  • proprietaireTel (chaîne de caractères)
  • proprietaireFax (chaîne de caractères)
  • proprietaireMail (chaîne de caractères)
  • locataireEntete (chaîne de caractères)
  • locataireNom (chaîne de caractères)
  • locataireCompany (chaîne de caractères)
  • locataireAdresse (chaîne de caractères)
  • locataireCP (chaîne de caractères)
  • locataireVille (chaîne de caractères)
  • locataireCountry (chaîne de caractères)
  • locataireTel (chaîne de caractères)
  • locataireMail (chaîne de caractères)
  • bienAdresse (chaîne de caractères)
  • bienCp (chaîne de caractères)
  • bienVille (chaîne de caractères)
  • bienCountry (chaîne de caractères)
  • bienAdresseCorrigee (chaîne de caractères)
  • bienLieuInterne (chaîne de caractères)
  • bienCadastre (chaîne de caractères)
  • bienParcelle (chaîne de caractères)
  • bienLot (chaîne de caractères)
  • bienNature (chaîne de caractères)
  • bienIghErp (chaîne de caractères)
  • typeTransaction (chaîne de caractères)
  • bienDescription (chaîne de caractères)
  • typeLogement (chaîne de caractères)
  • bienAnneeConstruction (chaîne de caractères)
  • bienPerimetre (chaîne de caractères)
  • commerciaux (chaîne de caractères)
  • commerciauxAutre (chaîne de caractères)
  • backoffice (chaîne de caractères)
  • notaireEntete (chaîne de caractères)
  • notaireNom (chaîne de caractères)
  • notaireCompany (chaîne de caractères)
  • notaireAdresse (chaîne de caractères)
  • notaireCp (chaîne de caractères)
  • notaireVille (chaîne de caractères)
  • notaireCountry (chaîne de caractères)
  • notaireTel (chaîne de caractères)
  • notaireFax (chaîne de caractères)
  • notaireMail (chaîne de caractères)
  • rapportDestinataires (chaîne de caractères) : 'Propriétaire' ,'Apporteur', 'Locataire', 'Notaire', 'Autre'
  • rapportDestinatairesOptions (chaîne de caractères) : '0000' -> '1111'
  • rapportDestinatairesMail (chaîne de caractères)
  • operateurReperageNom (chaîne de caractères) : Cette valeur doit être strictement égale à celle présente en base de données
  • rdvContactNomTel (chaîne de caractères)
  • rdvClefs (chaîne de caractères)
  • rdvPrecisions (chaîne de caractères)
  • dateCommande (chaîne de caractères) : Format (YYYY-MM-DD)
  • rdvDuree (entier) : en minutes
  • rdvDate (chaîne de caractères) : Format (YYYY-MM-DD)
  • rdvHeure (chaîne de caractères) : Format (00:11)
  • rapportDate (chaîne de caractères) : Format (YYYY-MM-DD)
  • rapportDateEnvoyee (chaîne de caractères) : Format (YYYY-MM-DD)
  • numDevis (chaîne de caractères)
  • facturationDate (chaîne de caractères) : Format (YYYY-MM-DD)
  • numFacture (chaîne de caractères)
  • facturationDateFin (chaîne de caractères) : Format (YYYY-MM-DD)
  • facturationCompteClient (chaîne de caractères)
  • rapportFacturationOptions (chaîne de caractères)
  • rapportFacturation (chaîne de caractères)
  • date1erPaiement (chaîne de caractères)
  • facturationRestante (chaîne de caractères)
  • invoiceDescription (chaîne de caractères)
  • km (chaîne de caractères)
  • valeurBien (chaîne de caractères)
  • priceFai (chaîne de caractères)
  • adresseWebDossier (chaîne de caractères)
  • missionMemo (chaîne de caractères)
  • rapportType (chaîne de caractères) : '00000000000000000000000000000000000000' -> '111111111111111111111111111111111111111'
  • rapportTypeExpertise (chaîne de caractères) : '000000000000000000000000000000000000000' -> '111111111111111111111111111111111111111'
  • bienDescriptionOption (chaîne de caractères)
  • bienLotCaveCellier (chaîne de caractères)
  • bienSurfaceTerrain (chaîne de caractères)
  • bienLotParkingGarage (chaîne de caractères)
  • bienLotAutre (chaîne de caractères)

Méthode permettant l'ajout ou l'édition d'un numéro de dossier en renseignant l'identifiant de la base de données retourné par la méthode "get-info" dans le cas de l'édition.

Toutes les variables qui sont soumises seront mises à jour. Pour ne pas modifier un champ, ne pas transmettre la variable correspondante. Toute variable soumise sans valeur videra le champ présent en base de données.

Exemple de réponse avec succès:

 

 

Ajout d'une ligne de facture à un dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/add-invoice-entry

Headers

Authorization : Bearer {{token}}

Variables:

  • id (entier) : ID du dossier *

  • refcommande (entier)

  • nomproduit (chaîne de caractères)

  • produit (chaîne de caractères)

  • tauxtva (nombre à virgule flottante)

  • pu (nombre à virgule flottante)

  • tva (nombre à virgule flottante)

  • ht (nombre à virgule flottante)

  • quantite (entier)

  • remise (nombre à virgule flottante)

  • ttc (nombre à virgule flottante)

Description:

Cette méthode permet d'ajouter une ligne de facture correspondant à un dossier. Les détails de la ligne de facture incluent l'ID du dossier, la référence de commande, le nom du produit, le produit, le taux de TVA, le prix unitaire, la TVA, le montant hors taxe, la quantité, la remise, et le montant TTC.

Exemple de retour:


 

Edition d'une ligne de facture d'un dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/edit-invoice-entry

Headers

Authorization : Bearer {{token}}

Variables:

  • id (entier) * 
  • numfacturation (chaîne de caractères) * 
  • refcommande (entier)
  • nomproduit (chaîne de caractères)
  • produit (chaîne de caractères)
  • tauxtva (nombre à virgule flottante)
  • pu (nombre à virgule flottante)
  • tva (nombre à virgule flottante)
  • ht (nombre à virgule flottante)
  • quantite (entier)
  • remise (nombre à virgule flottante)
  • ttc (nombre à virgule flottante)

Description:

Cette méthode permet de modifier une ligne de facture correspondant à un dossier.

Exemple de retour:
 

 

Suppression d'une ligne de facture d'un dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/delete-invoice-entry

Headers

Authorization : Bearer {{token}}

Variables:

  • id (entier) *
  • idDossier (entier) *

Description:

Cette méthode permet de supprimer une ligne de facturation associée à un dossier spécifique. L'identifiant de la ligne de facturation ainsi que l'identifiant du dossier doivent être spécifiés pour effectuer la suppression.


 

Ajout d'une ligne de paiement d'un Dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/add-payment

Headers

Authorization : Bearer {{token}}

Variables:

  • id (entier) *
  • datePaiement (chaîne de caractères)
  • typePaiement (chaîne de caractères)
  • details (chaîne de caractères)
  • quantitePayee (nombre à virgule flottante)
  • numeroDepot (chaîne de caractères)

Description:

Cette méthode permet d'ajouter une ligne de facture à un dossier spécifique.

Edition d'une ligne de paiement d'un Dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/edit-payment

Headers

Authorization : Bearer {{token}}

Variables:

  • id (entier) *
  • idPayment (entier) *
  • datePaiement (chaîne de caractères)
  • typePaiement (chaîne de caractères)
  • details (chaîne de caractères)
  • quantitePayee (nombre à virgule flottante)
  • numeroDepot (chaîne de caractères)

Description:

Cette méthode permet de modifier une ligne de facture à un dossier spécifique.


Suppression d'une ligne de paiement d'un Dossier

URL soumise à facturation spécifique

Requête POST à l'URL:

http://{votre-sous-domaine}.liciweb.com/rest/dossier/delete-payment

Headers

Authorization : Bearer {{token}}

Variables:

  • id (entier) *
  • idPayment (entier) *

Description:

Cette méthode permet de supprimer une ligne de facture associée à un dossier spécifique.