Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Exemple d’import partenaire à partir de l’API Dailybiz avec le langage PHP
L’exemple joint à cette documentation a pour but de simuler un import partenaire.
La fonction d’import partenaires permet de récupérer les commandes d’un site e-commerce pour les intégrer en tant que commandes ou factures dans la gestion commerciale. Cet exemple part du principe qu’un fichier XML contenant les commandes à importer a déjà été généré par le site e-commerce. Le programme va donc charger ce fichier et le traiter pour importer son contenu dans la grille d’import.
L’exemple est conçu pour être utilisé via un navigateur web.
Pour l’exécuter, il est nécessaire :
D’installer et activer un serveur web (IIS, Apache)
D’installer et configurer PHP
D’avoir une connexion internet active pour communiquer avec le service web
L’utilisation d’un environnement de développement (IDE) n’est pas requise.
Ensuite suivez ces étapes:
Télécharger l’archive
Dézipper le fichier dans le répertoire du serveur web configuré pour l’emplacement des fichiers PHP.
Vous devez au préalable éditer le fichier PHP «ImportPartenaire.php» pour remplacer les valeurs de paramètres de la méthode d’authentification avec vos codes d’accès.
Exemple : Pour la méthode authentification1, vous devez remplacer par vos propres codes d’accès les valeurs des paramètres «MonCodeAbonné», «MonIdentifiant», «MonMotDePasse».
Veuillez noter que les codes d’accès doivent correspondre obligatoirement à un compte administrateur.
Le deuxième fichier «Import.xml» contient les données à importer. Le fichier est au format XML et contient une balise «FICHE» par ligne de commande.
Plusieurs lignes peuvent correspondre à la même commande si le numéro de pièce est commun. Vous pouvez éditer ce fichier si vous souhaitez ajouter des fiches ou modifier les données existantes.
Avant de tester l’exemple, il est nécessaire de paramétrer les options de l’import partenaires dans le logiciel. Notamment pour la numérotation des pièces, le type de pièce à créer, etc.
Pour plus d’informations sur l’import partenaires, veuillez-vous référer à l’aide en ligne ou contacter notre assistance technique.
Afin de pouvoir exécuter l’exemple, ouvrez une fenêtre de navigateur puis indiquez dans la barre d’adresse, l’url d’emplacement du fichier «ImportPartenaire.php».
Attention : ce programme n’affiche pas de résultat dans le navigateur; vous obtiendrez une page blanche.
Pour vérifier le résultat, connectez-vous au logiciel avec les mêmes codes d’accès que ceux indiqués dans l’exemple. Puis rendez-vous dans la grille d’import partenaires ventes.
Dans cet exemple, les classes PHP suivantes sont utilisées (pour en savoir plus, consulter: http://php.net/) :
SoapClient : fournit le client pour le protocole SOAP
SoapHeader: construit l’en-tête SOAP
DOMDocument: crée un objet DOMDocument
L’API fonctionne via un service web basé sur le protocole SOAP. La première instruction permet d’instancier le client SOAP en passant en paramètre l’adresse du fichier de description des services (wsdl).
Toutes les instructions suivantes qui utiliseront le service web, seront des méthodes de l’objet instancié avec le client SOAP.
La première méthode sert à vous authentifier.
L’étape suivante consiste à la mise en place de l’en-tête (header) contenant le jeton de session obtenu à partir de l’authentification. Cette étape est optionnelle si vous utilisez les méthodes avec session.
L’appel à méthode DefinirModule permet de vous connecter à la bonne base de données pour exécuter les méthodes suivantes.
On charge le fichier XML contenant les données à importer en mémoire avec la méthode load de la classe DOMDocument.
L’import dans la grille d’import partenaire est réalisé avec la méthode InsererTable qui reçoit une chaîne de caractères correspondant à un message XML en paramètre. Afin que le document en mémoire soit converti en chaîne de caractère, on applique la méthode saveXML de la classe DOMDocument.
Les éléments suivants sont nécessaires à l’authentification depuis le Web-Service :
Code abonné
Identifiant
Mot de passe
Ils sont également utilisés pour votre connexion au logiciel.
Pour plus d’informations, merci de contacter notre support technique.
En option, vous pouvez également utiliser :
Code Client Géré
Nom Exercice
Important : les droits d’accès ne sont pas vérifiés dans le cadre de l’API. Si l’authentification est réalisée avec un accès non administrateur, il n’y a aucune restriction d’accès. C’est au programme appelant le Web-Service de redéfinir, s’il y a lieu, les limitations.
Le Web-Service est accessible par l’URL suivante : https://exe.dailybiz.com/idylisapi.asmx
Certaines méthodes intègrent un paramètre XML mentionnant les données à insérer ou mettre à jour dans la base de données. La syntaxe du XML doit être la suivante :
Toutes les méthodes suivies par le suffixe ‘Session’ peuvent être utilisées sans la nécessité de ‘SoapHeader’. Pour ce faire, il faut appeler la méthode avec les mêmes paramètres, en ajoutant le 'Session ID' comme premier paramètre.
Exemple (VB.net)
Exemples utilisant l'ensemble des méthodes de l'API
Les exemples joints à cette documentation correspondent à toutes les méthodes que vous pouvez utiliser avec l’API.
Liste des méthodes pour lesquelles vous trouverez un exemple :
Authentification revendeur
Authentification1
Authentification2
Authentification3
CP_PurgerGrilleSaisie
CP_PurgerGrilleSaisieSession
CP_ValiderGrilleSaisie
CP_ValiderGrilleSaisieSession
DefinirModule
DefinirModuleSession
GC_ValiderPiece
GC_ValiderPieceSession
InsererTable
InsererTableSession
LireTable
LireTableSansCData
LireTableSansCDatasession
LireTableSession
MajSousTable
MajTable
MajTableSession
RefUtilisateur
RefUtilisateurSession
SuppressionTable
SuppressionTableSession
Les exemples sont conçus pour être utilisés via un navigateur web. Pour les exécuter, il est nécessaire :
D’installer et activer un serveur web (IIS, Apache)
D’installer et configurer PHP
D’avoir une connexion internet active pour communiquer avec le service web
L’utilisation d’un environnement de développement (IDE) n’est pas requise.
Ensuite suivez ces étapes :
Télécharger l’archive
Dézipper le fichier dans le répertoire du serveur web configuré pour l’emplacement des fichiers PHP.
Vous devez au préalable éditer les fichiers PHP pour remplacer certaines valeurs de paramètres.
Cette manipulation est obligatoire au moins pour les paramètres des méthodes d’authentification. Chaque fichier exemple contient une méthode d’authentification.
Si vous souhaitez tester les exemples avec vos données, il faut donc indiquer vos codes d’accès idylis.com.
Veuillez noter que les codes d’accès doivent correspondre obligatoirement à un compte administrateur sur idylis.com.
Ensuite pour afficher le résultat, ouvrez une fenêtre de navigateur puis indiquez dans la barre d’adresse, l’url d’emplacement du fichier exemple que vous souhaitez tester.
Dans les exemples, les classes PHP suivantes sont utilisées(pour en savoir plus, consulter: http://php.net/) :
SoapClient : fournit le client pour le protocole SOAP
SoapHeader : construit l’en-tête SOAP
SimpleXML: fournit les outils pour traiter les réponses XML en vue de l’affichage
L’API idylis.com fonctionne via un service web basé sur le protocole SOAP. La première instruction permet d’instancier le client SOAP en passant en paramètre l’adresse du fichier de description des services (wsdl).
Toutes les instructions suivantes qui utiliseront le service web, seront des méthodes de l’objet instancié avec le client SOAP.
Chaque exemple comporte au moins une phase d’authentification.
L’étape suivante consiste à la mise en place de l’en-tête (header) contenant le jeton de session obtenu à partir de l’authentification. Cette étape est optionnelle si vous utilisez les méthodes avec session.
Après ces instructions initiales, vous trouverez l’appel à la méthode qui est l’objet de l’exemple.
Dans les cas où la méthode renvoie des données, vous trouverez des instructions complémentaires pour gérer l’affichage de la réponse.
Les réponses d’un service web SOAP sont des messages au format XML. Afin de manipuler le flux retourné, on utilise la classe SimpleXML. Celle-ci permet de transformer la réponse XML en un objet aisément manipulable (possibilité d’adresser directement un élément ou de parcourir le contenu de l’objet comme avec un tableau). Cette extension est incluse et active par défaut dans les versions récentes de PHP (à partir de 5.1.2).
On instancie la classe SimpleXML en passant en paramètre la réponse du service web.
La réponse à l’utilisation d’une méthode de lecture de table est un flux XML dont la structure se présente comme suit :
La réponse rappelle le nom de la table lue ainsi que les critères et l’ordre utilisés.
La balise <FICHE> correspond à un enregistrement dans la table. Il y aura donc autant d’itération de cette balise que d’enregistrements retournés. Ensuite entre les balises <FICHE>, on trouve la liste des champs avec leur valeur respective.
On peut afficher le contenu de la table en parcourant le tableau «FICHE» ou en atteignant directement un élément.
Pour afficher les valeurs des champs «Code fournisseur», «Nom», «Adresse1» pour tous les enregistrements retournés de la table fournisseurs :
Il y a certaines méthodes dans l’API qui ont une version avec le suffixe JSON. La différence par rapport les autres versions homonymes c’est le format JSON utilisé sur les données renvoyées par la méthode. Le bout ce de rendre plus facile la consommation des données pour les applications qui utilisent plutôt le format JSON au lieu du format XML. Dans ce cas-là, les codes et message d’erreur en cas d’échec seront également mis dans le format JSON.
Attention ! Le protocole SOAP pour l'échange des messages entre le Web-Service Dailybiz et l’application consommatrice est toujours utilisé.
Ces sont uniquement les données qui sont mis en format JSON et enveloppées dans un message SOAP de réponse.
Exemple :
(VB.net)
Retourne (JSON) :
Exemple de création de virements fournisseurs à partir de l’API idylis.com avec le langage PHP
Le fichier FichierVirementFournisseur.php joint à titre d’exemple permet, via l’API, d’alimenter la table des virements fournisseurs (module Liaisons bancaires) en exploitant les écritures passées sur les comptes fournisseurs (module Comptabilité).
Un crochet par le module Gestion commerciale permettra de récupérer les coordonnées bancaires des comptes (IBAN et BIC notamment). En partant de la Comptabilité, vous pourrez agir sur la totalité des virements fournisseurs, qu’ils soient liés à votre activité commerciale ou à vos coûts de fonctionnement.
L’exemple est conçu pour être utilisé via un navigateur web. Pour l’exécuter, il est nécessaire :
d’installer et d’activer un serveur web (IIS, Apache)
d’installer et de configurer PHP
d’avoir une connexion internet active pour communiquer avec le service web
L’utilisation d’un environnement de développement (IDE) n’est pas requise.
Ensuite suivez ces étapes :
1. Téléchargez l’archive.
2. Dézippez le fichier dans le répertoire du serveur web configuré pour l’emplacement des fichiers PHP.
Avant de tester l’exemple, nous vous suggérons de préparer un mini jeu de test :
Dans le module de Comptabilité, créez deux comptes fournisseurs (de type 401XXX).
Saisissez ensuite, dans le journal des achats, deux écritures d’achat au crédit des fournisseurs. Enregistrez-les.
Dans le module de Gestion commerciale, créez les comptes fournisseurs avec leurs coordonnées bancaires :
Lorsque les données existent dans le logiciel, vous pouvez démarrer le test :
Editez le fichier FichierVirementFournisseur.php.
Modifiez les valeurs de connexion de la méthode d’authentification avec vos codes d’accès (Administrateur).
Ouvrez une fenêtre de navigateur puis indiquez dans la barre d’adresse, l’url du fichier FichierVirementFournisseur.php, par exemple : HTTP://LOCALHOST/DOSSIEREXEMPLESPHPFICHIER/VIREMENTFOURNISSEUR.PHP Lorsque vous validez l’URL, le traitement se fait automatiquement. Rien n’est visible, sauf si vous placez des var_dump(); ou des print_r() dans le code.
Vérifiez le résultat dans le module Liaisons bancaires :
INSERT IMAGE !!
Cet exemple utilise un certain nombre de classes PHP sur lesquelles vous pouvez en savoir plus ici : http://php.net/.
L’API idylis.com fonctionne via un service web basé sur le protocole SOAP. La première instruction permet d’instancier le client SOAP en passant en paramètre l’adresse du fichier.wsdl de description des services.
SoapClient : fournit le client pour le protocole SOAP
SoapHeader : construit l’en-tête SOAP*
Toutes les instructions qui suivent sont des méthodes de l’objet instancié avec le client SOAP.
En savoir plus : les différentes méthodes sont décrites dans le module Dev Center, menu API/Descriptif des services.
Un clic sur une méthode affiche un exemple de la structure attendue.
Pour pouvoir tester l’exemple fourni, vous devez en premier lieu indiquer vos codes d’accès idylis.com.
Pour la méthode authentification1, remplacez les valeurs des paramètres « MonCodeAbonné », « MonIdentifiant », « MonMotDePasse » par vos propres informations de connexion.
Attention, les codes d’accès doivent obligatoirement correspondre à un compte administrateur de Divalto idylis.
Elle permet de récupérer le jeton de session obtenu à partir de l’authentification. Cette étape est optionnelle si vous utilisez les méthodes avec session.
Le programme va identifier, dans le module Comptabilité les écritures passées sur les comptes fournisseurs.
Cette méthode permet de vous connecter à la base de données du module visé (ici, le module de Comptabilité « CP ») avant d’exécuter les méthodes invoquées par la suite.
A noter : plus loin dans la procédure, vous aurez également besoin de la base de données du module de Gestion commerciale – Facturation « FA », ce qui nécessitera de rappeler la méthode DefinirModule en donnant cette fois-ci le code module « FA ».
Une fois le module désigné, il s’agit d’indiquer avec la méthode LIRETABLE la table dans laquelle aller chercher les informations (ici « CP_Ecritures »), en précisant les critères de sélection des données en paramètres.
En savoir plus : le nom des tables par module est indiqué dans le module Dev Center, onglet [API], sous-onglet [Dictionnaire des données]. Un double-clic sur une table affiche les champs associés et leurs propriétés.
e service web retourne la réponse au format XML. Les données qui nous intéressent dans la réponse SOAP sont incluses dans le champ LIRETABLERESULT dont le contenu est repris dans un tableau via la classe SimpleXMLElement. Cette classe facilite le traitement de données XML en les convertissant dans un tableau de fiches (suite de balises ).
On teste au préalable que la méthode LireTable renvoie bien un enregistrement.
Une fois les comptes fournisseurs et les montants à payer identifiés, il faut aller récupérer les coordonnées bancaires indiquées dans le module Gestion commerciale.
Puisqu’il s’agit de lire une table dans un autre module, et donc une autre base de données, il convient de rappeler la méthode DEFINIRMODULE. Le module concerné est cette fois Gestion commerciale - Facturation « FA ».
La méthode LIRETABLE va chercher les informations bancaires du fournisseur à partir du compte comptable précédemment récupéré :
On ajoute au tableau destiné aux virements fournisseurs les coordonnées bancaires du compte et un compteur initialisé à 0 en prévision de la boucle suivante.
La boucle qui suit permet de cumuler les écritures et données d’un même compte fournisseur.
La seconde boucle permet de :
calculer le solde de chaque compte fournisseur et de ne garder que les comptes au solde créditeur,
récupérer toutes les informations nécessaires au fichier de virements SEPA,
compléter un nouveau tableau VirLBA
Elle vient terminer la boucle et permet d’alimenter la table Virements du module Liaisons bancaires :
Note : il n’est pas nécessaire d’appliquer la méthode DEFINIRMODULE avant d’insérer les virements car les modules Liaisons bancaires et Gestion commerciale partagent la même base de données.
Pour chaque méthode, nous allons décrire :
L'objectif de la méthode
Les paramètres
Les données renvoyées
Quelques exemples
Cette méthode authentifie l’utilisateur et crée une session temporaire pour accéder à la base de données.
Code Abonné
Identifiant
Mot de Passe
La méthode retournera le code de la session créée en cas d'authentification réussie. En cas d’échec, vous pouvez retourner les codes d’erreur suivants :
“-1” : Identifiant ou mot de passe invalide.
“-2” : Le client n’existe pas.
“-3” : Le client géré n'appartient pas à cet utilisateur.
Utilisez “SessionIDHeader” pour maintenir la session ouverte lors de l’exécution des méthodes nécessaires :
Les codes d’erreur retournés par la méthode d’authentification n’interrompent pas le processus et peuvent être transférés normalement vers les autres méthodes (au même titre que les codes de sessions).
Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.
Fonctionnement similaire à la méthode authentification1.
Code Abonne
Identifiant
Mot de passe
Code Client géré
La méthode retournera le code de la session créée en cas d'authentification réussie. En cas d’échec, vous pouvez retourner les codes d’erreur suivants :
“-1” : Identifiant ou mot de passe invalide.
“-2” : Le client n’existe pas.
“-3” : Le client géré n'appartient pas à cet utilisateur.
Utilisez “SessionIDHeader” pour maintenir la session ouverte lors de l’exécution des méthodes requises :
Les codes d’erreur retournés par la méthode d’authentification n’interrompent pas le processus et peuvent être transférés normalement vers les autres méthodes (au même titre que les codes de sessions).
Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.
Fonctionnement similaire à la méthode authentification1
Code Abonne
Identifiant
Mot de passe
Code Client géré
Nom Exercice
La méthode retournera le code de la session créée en cas d'authentification réussie. En cas d’échec, vous pouvez retourner les codes d’erreur suivants :
“-1” : Identifiant ou mot de passe invalide.
“-2” : Le client n’existe pas.
“-3” : Le client géré n'appartient pas à cet utilisateur.
Utilisez “SessionIDHeader” pour maintenir la session ouverte lors de l’exécution des méthodes requises :
Les codes d’erreur retournés par la méthode d’authentification n’interrompent pas le processus et peuvent être transférés normalement vers les autres méthodes (au même titre que les codes de sessions).
Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.
Cette méthode, dédiée aux abonnements revendeur uniquement, authentifie l’utilisateur et crée une session temporaire pour accéder à la base de données.
Code Revendeur
Identifiant
Mot de Passe
La méthode retournera le code de la session créée en cas d'authentification réussie.
En cas d’échec, vous pouvez retourner les codes d’erreur suivants :
“-1” : Identifiant ou mot de passe invalide.
“-2” : Le client n’existe pas.
“-3” : Le client géré n'appartient pas à cet utilisateur.
Utilisez “SessionIDHeader” pour maintenir la session ouverte lors de l’exécution des méthodes nécessaires :
Les codes d’erreur retournés par la méthode d’authentification n’interrompent pas le processus et peuvent être transférés normalement vers les autres méthodes (au même titre que les codes de sessions).
Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.
Cette méthode, dédiée aux logiciels tiers, délivre une clé temporaire de connexion à Dailybiz, grâce à la clé permanente disponible dans chaque fiche utilisateur.
La méthode retournera une clé temporaire de connexion à usage unique en cas d'authentification réussie.
En cas d’échec, vous pouvez retourner les codes d’erreur suivants :
Exemple :
(VB.net)
Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
cSessionID = idev.authentification_Tiers("token")
Utilisez “SessionIDHeader” pour maintenir la session ouverte lors de l’exécution des méthodes nécessaires :
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID
Les codes d’erreur retournés par la méthode d’authentification n’interrompent pas le processus et peuvent être transférés normalement vers les autres méthodes (au même titre que les codes de sessions).
Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.
Cette méthode récupère la clé refutilisateur.
La méthode retournera le refutilisateur.
Affiche (XML) :
Cette méthode permet de renvoyer les données d’une table et des tables connexes (soustables). Seules les données des tables et des “sous-tables” autorisées seront renvoyées.
NomTable : Nom de la table dans la base de données.
Criteres : Filtre utilisé pour lister les données spécifiques. (Where). Laissez vide pour ne pas filtrer.
Ordre : L’ordre dans lequel les résultats seront affichés. (Order By). Laissez vide pour ne pas trier.
SousTables : Liste les données des sous-tables liées à la table principale. Mettre “1” ou “0” pour utiliser ou non cette option.
PieceAttachee : Retourne les fichiers présents dans la table encodés en base64. Mettre “1” ou “0” pour utiliser ou non cette option. ✓
AvecCompression : Compresse les données et les retourne en base64. Mettre “1” ou “0” pour utiliser ou non cette option.
TotalParPage : Pagine la réponse avec le nombre d'enregistrement/fiche indiqué. Ce paramètre est optionnel.
Page : Indique le numéro de page à consulter si on demande une pagination de la réponse avec le paramètre "TotalParPage". Ce paramètre est optionnel.
TotalLignes : Indique le nombre de lignes que contient la réponse en fonction des paramètres "NomTable" et "Criteres". Il peut être utilisé avant un appel avec les paramètres de pagination pour optimiser la réponse. Ce paramètre est optionnel.
Fichier XML contenant les données des tables et des sous-tables, avec code et message d’erreur en cas d’échec.
(VB.net)
Affiche (XML) :
Tous les champs complémentaires créés par l'utilisateur seront inclus dans le code XML retourné. Pour filtrer et trier les résultats en utilisant les paramètres “Criteres” et “Ordre”, ajoutez le préfixe "COMP_" dans le nom du champ complémentaire et supprimez tous les espaces.
(VB.net)
Nom du champ = Champ Utilisateur
Ce paramètre vous permettra d'ignorer les champs personnalisés et calculés pour une réponse plus rapide.
Similaire à la méthode LireTable, mais Il retourne um XML sans les tags “CDATA”.
NomTable : nom de la table dans la base de données.
Criteres : filtre utilisé pour lister les données spécifiques. (Where). Laissez vide pour ne pas filtrer.
Ordre : l’ordre dans lequel les résultats seront affichés. (Order By). Laissez vide pour ne pas trier.
SousTables : liste les données des sous-tables liées à la table principale. “0” ou “1”.
PieceAttachee : retourne les fichiers présents dans le tableau, transformés à la base64. “0” ou “1”.
AvecCompression : comprime les données retournées et retourne sur la base64. “0” ou “1”.
TotalLignes : Indique le nombre de lignes que contient la réponse en fonction des paramètres "NomTable" et "Criteres". Il peut être utilisé avant un appel avec les paramètres de pagination pour optimiser la réponse. Ce paramètre est optionnel.
Page : Indique le numéro de page à consulter si on demande une pagination de la réponse avec le paramètre "TotalParPage". Ce paramètre est optionnel.
TotalParPage : Pagine la réponse avec le nombre d'enregistrement/fiche indiqué. Ce paramètre est optionnel.
Fichier XML contenant les données des tables et des sous-tables, avec code et message d’erreur en cas d’échec.
(VB.net)
Affiche (XML) :
Tous les champs complémentaires créés par l'utilisateur seront inclus dans le code XML retourné. Pour filtrer et trier les résultats en utilisant les paramètres “Criteres” et “Ordre”, ajoutez le préfixe "COMP_" dans le nom du champ complémentaire et supprimez tous les espaces.
(VB.net) Nom du champ = Champ Utilisateur
Mettre à jour les données d’une table. Seules les données des tables avec autorisation d’accès seront mises à jour.
Fiche : XML avec les données de la table à mettre à jour. Les champs de clé primaire (primary Key) sont obligatoires.
Fichier XML confirmant la mise à jour ou le code et le message d’erreur.
Les champs complémentaires peuvent aussi être mis à jour dans cette méthode. Pour ce faire, insérez ces champs en XML avec les champs de la table, en ajoutant le préfixe "COMP_” au nom du champ complémentaire et en supprimant tous les espaces. Illustration dans l'exemple ci-dessous (nom du champ complémentaire = “Champ Utilisateur”).
(VB.net)
Affiche (XML) :
Mettre à jour les données d’une sous-table. Seules les données des tables avec autorisation d’accès seront mises à jour.
Fiche : XML avec les données de la sous-table à mettre à jour. Le XML doit aussi contenir les données de la table connexe à cette sous-table. Les champs de clé primaire (primary Key) sont obligatoires.
Nom sous table : Nom de la sous-table dans la base de données.
Cle sous table : Nom du premier champ qui identifie l’enregistrement dans la sous-table (obligatoire).
Cle sous table 2 : Nom du second champ qui identifie l’enregistrement dans la sous-table (optionnel, laissez vide s’il n’existe pas)
Retourne un XML confirmant la mise à jour ou le code et le message d’erreur.
Les champs complémentaires peuvent aussi être mis à jour dans cette méthode. Pour ce faire, insérez ces champs en XML avec les champs de la table, en ajoutant le préfixe "COMP_” au nom du champ complémentaire et en supprimant tous les espaces. Illustration dans l'exemple ci-dessous (nom du champ complémentaire = “Champ Utilisateur”).
(VB.net)
Affiche (XML) :
Insérer les données dans une table. Seules les données des tables avec autorisation d’accès seront insérées.
Fiche : XML avec les données de la table qui seront insérées. Les enregistrements déjà existants (confirmation par la clé primaire) ne seront pas ajoutés.
Retourne un XML en confirmant la mise à jour ou le code et le message d’erreur.
Les champs complémentaires peuvent aussi être insérés dans cette méthode. Pour ce faire, insérez ces champs en XML avec les champs de la table, en ajoutant le préfixe "COMP_” au nom du champ complémentaire et en supprimant tous les espaces. Illustration dans l'exemple ci-dessous (nom du champ complémentaire = “Champ Utilisateur”).
(VB.net)
Retourne (XML) :
Supprimer les données d’une table. Seules les données des tables avec autorisation d’accès seront supprimées.
Nom Table : Nom de la table de la base de données.
Cle value : Valeur de la clé primaire de la table se référant à l’enregistrement à supprimer.
Affiche un XML en confirmant que l’enregistrement a été supprimé ou avec le code et le message d’erreur.
Les données enregistrées dans les champs complémentaires seront également supprimées.
(VB.net)
Affiche (XML)
Purger les écritures de la comptabilité existant dans les grilles de saisie.
Retourne un XML en confirmant la suppression des écritures ou affichant le code et le message d’erreur.
(VB.net)
Retourne (XML) :
Valider les écritures de la comptabilité existant dans les grilles de saisie.
Action : “1” pour brouillard, “2” pour écritures.
Rapide : “0” pour grille de saisie en vrac, “1” pour grille de saisie rapide en vrac.
Retourne un XML en confirmant la validation des écritures ou affichant le code et le message d’erreur.
(VB.net)
Retourne (XML) :
Valider les pièces commerciales existant dans la gestion commerciale.
Piece : Type de pièce commerciale à valider. Options:
“FA_FACTURES”
“FA_AVOIRS”
“FA_FACTURESACHATS”
“FA_AVOIRSACHATS”
“FA_BL”
“FA_BR”
CodePiece : Code de la pièce commerciale à valider. Seules les pièces non validées et avec “TOTHT G” différent de 0 peuvent être validées.
Retourne un XML en confirmant la validation de la pièce commerciale ou le code et message d’erreur.
(VB.net)
Retourne (XML) :
Permet à l'utilisateur de modifier la base de données en fonction du module à utiliser.
CodeModule : préfixe du module à utiliser.
Cette méthode ne renvoie pas de données.
La méthode "GC_ValiderPiece" n'exige pas l'utilisation de la méthode "DefinirModule". Le module "CP" et tous les autres modules qui utilisent la même base de données comptable ne requièrent pas l'utilisation de la méthode "DefinirModule".
Valider les lignes existant dans les grilles d’imports partenaires sur la gestion commerciale (ventes et achats).
TypeImportation : “V” pour ventes, “A” pour achats.
TypePiece : “0” pour générer des factures, “1” pour générer des commandes.
Retourne un XML en confirmant la validation des écritures ou affichant le code et le message d’erreur.
(VB.net)
Retourne (XML) :
Lancer une synchronisation du type dailyapps, e-commerce ou alors PDV qui ira importer ou exporter des données depuis et vers une API tiers. Ce traitement est toujours déclenché de manière asynchrone sur le serveur Dailybiz. Donc la réponse de la web méthode sera immédiate n’importe quel soit la charge de données existant entre l’API tiers et le logiciel Dailybiz.
Fichier XML contenant un message de success avec un champ RefTraitement et le message de déclenchement correspondant. La valeur du champ RefTraitement sert comme référence pour la vérification à posteriori de l’état d’exécution de la synchronisation. Pour la vérification, vous pouvez utiliser la méthode GC_VerificationSynchronisation expliquée par ailleurs dans ce document. Dans le cas d’une erreur le code et le message correspondant seront renvoyés.
Exemple :
(VB.net)
Retourne (XML) :
Vérifier l’état actuel d’exécution d’une synchronisation déclenchée précédemment. Comme le traitement d’une synchronisation est toujours exécuté de manière asynchrone sur le serveur Dailybiz, la web méthode GC_VerificationSynchronisation permet de savoir si le traitement est en cours d’exécution ou pas.
Fichier XML contenant un message de verification avec le champ "RefTraitement", un champ "Message" avec l’étape actuelle de la synchronisation, un champ "Progression" avec le pourcentage de progression dans l’étape actuelle et un champ "Termine" avec une valeur logique pour indiquer si la synchronisation est terminée.
Exemple :
(VB.net)
Retourne (XML) :
Lancer une synchronisation du type dailyapps, e-commerce ou alors PDV qui ira importer ou exporter des données depuis et vers une API tiers. Ce traitement est toujours déclenché de manière asynchrone sur le serveur Dailybiz. Donc la réponse de la web méthode sera immédiate n’importe quel soit la charge de données existant entre l’API tiers et le logiciel Dailybiz.
Fichier XML contenant un message de success avec un champ RefTraitement et le message de déclenchement correspondant. La valeur du champ RefTraitement sert comme référence pour la vérification à posteriori de l’état d’exécution de la synchronisation. Pour la vérification, vous pouvez utiliser la méthode GC_VerificationSynchronisation expliquée par ailleurs dans ce document. Dans le cas d’une erreur le code et le message correspondant seront renvoyés.
Exemple :
(VB.net)
Retourne (XML) :
Renvoyer les informations d'un compteur CRM.
Fichier XML contenant un message de success avec un champ RefTraitement et le message de déclenchement correspondant. La valeur du champ RefTraitement sert comme référence pour la vérification à posteriori de l’état d’exécution de la synchronisation. Pour la vérification, vous pouvez utiliser la méthode GC_VerificationSynchronisation expliquée par ailleurs dans ce document. Dans le cas d’une erreur le code et le message correspondant seront renvoyés.
Exemple :
(VB.net)
Retourne (XML) :
Téléchargez le guide :
Les codes d’erreur “-1”, “-2” et “-3” sont uniquement renvoyés par la méthode d’authentification. Lorsque l'un de ces codes est transmis aux autres méthodes, il est bien identifié mais retranscrit par un code spécifique à chaque méthode, bien que décrivant la même erreur.
Préfixe | Libellé |
AC | Agenda |
AN | Annuaire |
BR | Mon compte revendeur |
CI | Administration clients |
CP | Comptabilité |
CR | GRC |
DP | Dossier permanent |
EC | Echanges |
EM | E-mailing |
FA | Gestion commerciale |
FT | Feuilles de temps |
GA | Associations |
GD | Gestion documentaire |
IB | Banque |
IC | Administration clients IPED |
IM | Immobilisation |
LB | Liaisons bancaires |
LN | Liasse fiscale |
MG | MiniGed |
NF | Notes de frais |
PA | Paye |
PE | Publications |
PQ | Plaquette |
PX | Paramétrage portail |
TF | Gestion des tâches |
|
|
|
|
Code | Description |
-99 | Erreur générique du système |
10 - MajTable | Le XML n’a pas le tag "FICHE" ou la table n’a pas les autorisations nécessaires |
11 - MajTable | Le champ clé est vide ou n’existe pas dans le XML |
12 - MajSousTable | Le champ clé n’a été pas renseigné |
13 - MajSousTable | La table n’a pas les autorisations nécessaires |
14 - MajSousTable | Les champs clés sont invalides |
15 - InsererTable | Le XML n’a pas le tag "FICHE" ou la table n’a pas les autorisations nécessaires |
16 - SuppressionTable | Le nom de la table est invalide, ou le champ clé est invalide ou la table n’a pas les autorisations nécessaires |
17 - GC_ValiderPiece | Aucune pièce commerciale à valider avec les critères renseignés |
18 - GC_ValiderPiece | Erreur de validation (accompagne le message) |
19 - GC_ValiderPiece | Erreur de validation |
20 - CP_ValiderGrilleSaisie | Erreur de validation (accompagne le message) |
21 - LireTable | SessionID invalide |
22 - MajTable | SessionID invalide |
23 - MajSousTable | SessionID invalide |
24 - InsererTable | SessionID invalide |
25 - SuppressionTable | SessionID invalide |
26 - CP_ValiderGrilleSaisie | SessionID invalide |
27 - GC_ValiderPiece | SessionID invalide |
28 - FicheFournisseur | Code fournisseur vide |
29 - FicheBDCAchat | Code commande vide |
30 - MajTable | XML invalide |
31 - MajSousTable | XML invalide |
32 - InsererTable | XML invalide |
34 - MajSousTable | XML mal conçu |
35 - InsererTable | XML mal conçu |
36 - CP_PurgerGrilleSaisie | SessionID invalide |
37 - RefUtilisateur | SessionID invalide |
38 - GC_ValiderImportPartenaires | SessionID invalide |
39 - MajDSN | SessionID invalide |
40 - GC_Synchronisation | SessionID invalide |
41 - GC_VerificationSynchronisation | La synchronisation a échoué |
42 - GC_VerificationSynchronisation | Impossible d'effectuer la synchronisation : l'URL de l'API est incorrecte ou la clé de l'API n'a pas les permissions requises. |
43 - GC_VerificationSynchronisation | Veuillez valider les pièces commerciales en attente dans la grille d'import partenaires ventes avant de lancer une nouvelle synchronisation. |
60 - CR_SoldeCompteur | SessionID invalide |