1 sur 11

Dev Center - API

API

L'API vous permet de créer, modifier et supprimer les informations des bases de données par des utilisateurs ayant des connaissances plus poussées en informatique ou par des programmeurs.

Manuel d'utilisation API

Téléchargez le guide :

Généralités

Authentification

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.

Web-Service

Le Web-Service est accessible par l’URL suivante : https://exe.dailybiz.com/idylisapi.asmx

XML

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 :

<NOMTABLE>
            		<FICHE>
               		<CHAMP1></CHAMP1>
<CHAMP2></CHAMP2>
               		<CHAMP3></CHAMP3>
			.
			.
               		<NOMSOUSTABLE>
                    			<SOUSFICHE>
                        				<CHAMP1></CHAMP1>
                				<CHAMP2></CHAMP2>
	               	 		<CHAMP3></CHAMP3>
					.
					.
                   			</SOUSFICHE>
                    			<SOUSFICHE>
                        				<CHAMP1></CHAMP1>
                				<CHAMP2></CHAMP2>
	                			<CHAMP3></CHAMP3>
					.
					.
                    			</SOUSFICHE>
                		</NOMSOUSTABLE>
           		 </FICHE>
        	</NOMTABLE>

Les codes d'erreur

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.

Méthodes sans 'SOAPHEADER'

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)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""
cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.DefinirModuleSession(cSessionID,“FB”)
cRetour = idev.LireTableSession(cSessionID, "FB_Fournisseurs", "COMP_ChampUtilisateur=’exemple’", "
COMP_ChampUtilisateur ASC", "1", "0", "0")

Méthodes avec sérialisation JSON

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) :

SDK - exemples d'utilisation

Import Partenaire PHP

Exemple d’import partenaire à partir de l’API Dailybiz avec le langage PHP

Introduction

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.

Pour commencer

Prérequis

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.

Utiliser l’exemple

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.

Aperçu du code

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.

Télécharger l'exemple

Méthodes API PHP

Exemples utilisant l'ensemble des méthodes de l'API

Introduction

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

Pour commencer

Prérequis

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.

Utiliser l’exemple

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.

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 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.

Exemple :
http://localhost/dossierexemplesphp/Authentification1.php

Aperçu du code

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).

Exemple :
$oWS= new SoapClient("http://exe.idylis.com/idylisapi.asmx?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.

Exemple :
$oSession=$oWS->authentification1(array('_codeAbonne'=>'MonCodeAbonné', '_identifiant'=>'MonIdentifiant', '_motdePasse'=>'MonMotDePasse'))

Exemple :
$oAuth['SessionID']= $oSession->AuthentificationAvec3Parametres1Result;
$oHeader= new SoapHeader('https://www.idylis.com/Idylisapi.asmx/','SessionIDHeader',$oAuth, false);
$oWS->__setSoapHeaders(array($oHeader));

Après ces instructions initiales, vous trouverez l’appel à la méthode qui est l’objet de l’exemple.

Exemple :
Lecture de la table fournisseurs :
$oRes=$oWS->LireTable(array('_nomtable'=>"FB_Fournisseurs", '_criteres'=>"", '_ordre'=>"", '_soustables'=>"0", '_pieceatache'=>"0", '_aveccompression'=>"0"))

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.

Exemple :
$oResXML= new SimpleXMLElement($oRes->LireTableResult);

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 :

<NOM_TABLE><CRITERES></CRITERES><ORDRE></ORDRE><FICHE><CHAMP1>valeur</ CHAMP1><CHAMP2>valeur</ CHAMP2></FICHE></NOM_TABLE>

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.

Exemple :
Pour  afficher  la  raison  sociale  du  premier  enregistrement  retourné  pour  la  table fournisseurs :
echo $oResXML->FICHE[0]->NOM;

Pour afficher les valeurs des champs «Code fournisseur», «Nom», «Adresse1» pour tous les enregistrements retournés de la table fournisseurs :

foreach ($oResXML->FICHE as $valeur){
echo 'Code Fournisseur : '.$valeur->CODEFOURNISSEUR.'<br>';
echo 'Raison Sociale : '.$valeur->NOM.'<br>';
echo 'Adresse 1 : '.$valeur->ADRESSE1.'<br>';
}

Télécharger l'exemple

Fichier Virements Fournisseur PHP

Exemple de création de virements fournisseurs à partir de l’API idylis.com avec le langage PHP

Introduction

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.

Prérequis

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.

Tester l'exemple

Préparation

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 :

Test

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 !!

Aperçu du code

Initialisation

Protocole soap

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.

Méthode authentification

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.

Propriété session

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.

Récupération des données comptables

Le programme va identifier, dans le module Comptabilité les écritures passées sur les comptes fournisseurs.

Méthode DefinirModule

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 ».

Méthode LireTable

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.

Récupération des données de facturation

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.

Regroupement des informations par compte

La boucle qui suit permet de cumuler les écritures et données d’un même compte fournisseur.

Calcul des soldes

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 :

Alimentation de la table virements

Méthode InsererTable

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.

Télécharger l'exemple

Méthodes

Introduction

Pour chaque méthode, nous allons décrire :

L'objectif de la méthode
Les paramètres
Les données renvoyées
Quelques exemples

Authentification1

Objectif

Cette méthode authentifie l’utilisateur et crée une session temporaire pour accéder à la base de données.

Paramètres

Code Abonné
Identifiant
Mot de Passe

Les données renvoyées

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.

Exemple :

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()

Dim cSessionID As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")

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.

Authentification2

Objectif

Fonctionnement similaire à la méthode authentification1.

Paramètres

Code Abonne
Identifiant
Mot de passe
Code Client géré

Données renvoyées

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.

Exemple :

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()

Dim cSessionID As String = ""

cSessionID = idev.authentification2("codeAbonne", "identifiant", "motDePasse", "codeClientGere")

Utilisez “SessionIDHeader” pour maintenir la session ouverte lors de l’exécution des méthodes requises :

idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.

Authentification3

Objectif

Fonctionnement similaire à la méthode authentification1

Paramètres

Code Abonne
Identifiant
Mot de passe
Code Client géré
Nom Exercice

Données renvoyées

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.

Exemple :

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()

Dim cSessionID As String = ""

cSessionID = idev.authentification3("codeAbonne", "identifiant", "motDePasse", "codeClientGere", "nomExercice")

Utilisez “SessionIDHeader” pour maintenir la session ouverte lors de l’exécution des méthodes requises :

idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.

Authentification_Revendeur

Objectif

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.

Paramètres

Code Revendeur
Identifiant
Mot de Passe

Les données renvoyées

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.

Exemple :

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()

Dim cSessionID As String = ""

cSessionID = idev.authentification_Revendeur("codeRevendeur", "identifiant", "motDePasse")

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

Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.

Authentification_Tiers

Objectif

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.

Paramètres

Token

Les données renvoyées :

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 :

“-1” : Identifiant ou mot de passe invalide.
“-2” : Le client n’existe pas.
“-3” : Le client géré n'appartient pas à cet utilisateur.
“-4” : Le paramètre «token» transmis n’est pas valide.

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

Chaque méthode va identifier les codes d’erreur et retourner les codes d’erreur qui lui sont propres.

RefUtilisateur

Objectif

Cette méthode récupère la clé refutilisateur.

Les données renvoyées

La méthode retournera le refutilisateur.

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""
cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID
cRetour = idev.RefUtilisateur()

Affiche (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>RefUtilisateur</message>
</success>

LireTable

Objectif

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.

Paramètres

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.

Syntaxe : <Champ> <connecteur> <Valeur> And/Or...

Ordre : L’ordre dans lequel les résultats seront affichés. (Order By). Laissez vide pour ne pas trier.

Syntaxe : <Champ> ASC/DESC

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.

Données renvoyées

Fichier XML contenant les données des tables et des sous-tables, avec code et message d’erreur en cas d’échec.

Exemple :

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""
cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID
cRetour = idev.LireTable("FB_Fournisseurs", "CodeFournisseur LIKE ’GA%’", "CodeFournisseur ASC", "1", "0", "0")

Affiche (XML) :

<?xml version="1.0" encoding="utf-16"?>
<FB_FOURNISSEURS>
 <CRITERES><![CDATA[codefournisseur like 'ga%']]></CRITERES>
 <ORDRE><![CDATA[codefournisseur asc]]></ORDRE>
 <FICHE>
 <ADMIN><![CDATA[smr]]></ADMIN>
 <ADRESSE1><![CDATA[kfdkjfgnkajf]]></ADRESSE1>
 <ADRESSE2><![CDATA[]]></ADRESSE2>
 <ADRESSE3><![CDATA[]]></ADRESSE3>
 <CLERIB><![CDATA[57]]></CLERIB>
 <CODE><![CDATA[]]></CODE>
 <CODEBANQUE><![CDATA[65465]]></CODEBANQUE>
 <CODEBICSWIFT><![CDATA[sgfsgfsg]]></CODEBICSWIFT>
 <CODEFOURNISSEUR><![CDATA[GAMMA]]></CODEFOURNISSEUR>
 <CODEGUICHET><![CDATA[65465]]></CODEGUICHET>
 <COMP_COMPTABLE><![CDATA[401313131000]]></COMP_COMPTABLE>
 <CP><![CDATA[10500]]></CP>
 <DATEARCHIVAGE><![CDATA[]]></DATEARCHIVAGE>
 <DATECREATION><![CDATA[05/08/2010 00:00:00]]></DATECREATION>
 <DOMICILIATION><![CDATA[dfgdfgdfg]]></DOMICILIATION>
 <EXM><![CDATA[]]></EXM>
 <FAX><![CDATA[]]></FAX>
 <IBAN><![CDATA[]]></IBAN>
 <NOM><![CDATA[!!!!!!!!!!!!!!!!!!]]></NOM>
 <NONSOUMISTVA><![CDATA[True]]></NONSOUMISTVA>
 <NUMEROCOMPTE><![CDATA[65465466]]></NUMEROCOMPTE>
 <PAYS><![CDATA[FRANCE]]></PAYS>
 <REFFOURNISSEUR><![CDATA[663]]></REFFOURNISSEUR>
 <REGLEMENT><![CDATA[]]></REGLEMENT>
 <SECTEUR><![CDATA[]]></SECTEUR>
 <SOUMISTVADOM><![CDATA[False]]></SOUMISTVADOM>
 <TEL><![CDATA[]]></TEL>
 <TVA_INTRA><![CDATA[]]></TVA_INTRA>
 <TYPE_NONSOUMISTVA><![CDATA[3]]></TYPE_NONSOUMISTVA>
 <TYPEPAIEMENT><![CDATA[]]></TYPEPAIEMENT>
 <TYPESOCIETE><![CDATA[0]]></TYPESOCIETE>
 <VILLE><![CDATA[Betignicourt]]></VILLE>
 <WEB><![CDATA[]]></WEB>
 <FB_CONTACTSFOURNISSEURS>
  <SOUSFICHE>
    <ADRESSE1><![CDATA[kfdkjfgnkajf]]></ADRESSE1>
    <ADRESSE2><![CDATA[]]></ADRESSE2>
    <ADRESSE3><![CDATA[]]></ADRESSE3>
    <CIVILITE><![CDATA[Monsieur]]></CIVILITE>
    <CODEFOURNISSEUR><![CDATA[GAMMA]]></CODEFOURNISSEUR>
    <COMMENTAIRE><![CDATA[]]></COMMENTAIRE>
    <CP><![CDATA[99000]]></CP>
    <EMAIL><![CDATA[]]></EMAIL>
    <FAX><![CDATA[]]></FAX>
    <FONCTION><![CDATA[]]></FONCTION>
    <IDENTIFIANTSKYPE><![CDATA[]]></IDENTIFIANTSKYPE>
    <MOBILE><![CDATA[]]></MOBILE>
    <NOM><![CDATA[sadfgasdf]]></NOM>
    <NUMEROSKYPE><![CDATA[]]></NUMEROSKYPE>
    <PAYS><![CDATA[FRANCE]]></PAYS>
    <PRENOM><![CDATA[gasfgas]]></PRENOM>
    <REFCONTACT><![CDATA[413]]></REFCONTACT>
    <REFDUPLICATION><![CDATA[0]]></REFDUPLICATION>
    <TEL><![CDATA[]]></TEL>
    <VILLE><![CDATA[Pas De La Casa]]></VILLE>
  </SOUSFICHE>
  <SOUSFICHE>
    <ADRESSE1><![CDATA[kfdkjfgnkajf]]></ADRESSE1>
    <ADRESSE2><![CDATA[]]></ADRESSE2>
    <ADRESSE3><![CDATA[]]></ADRESSE3>
    <CIVILITE><![CDATA[]]></CIVILITE>
    <CODEFOURNISSEUR><![CDATA[GAMMA]]></CODEFOURNISSEUR>
    <COMMENTAIRE><![CDATA[]]></COMMENTAIRE>
    <CP><![CDATA[10500]]></CP>
    <EMAIL><![CDATA[]]></EMAIL>
    <FAX><![CDATA[]]></FAX>
    <FONCTION><![CDATA[]]></FONCTION>
    <IDENTIFIANTSKYPE><![CDATA[]]></IDENTIFIANTSKYPE>
    <MOBILE><![CDATA[]]></MOBILE>
    <NOM><![CDATA[BIRDS]]></NOM>
    <NUMEROSKYPE><![CDATA[]]></NUMEROSKYPE>
    <PAYS><![CDATA[FRANCE]]></PAYS>
    <PRENOM><![CDATA[BEAUTY]]></PRENOM>
    <REFCONTACT><![CDATA[499]]></REFCONTACT>
    <REFDUPLICATION><![CDATA[]]></REFDUPLICATION>
    <TEL><![CDATA[]]></TEL>
    <VILLE><![CDATA[Betignicourt]]></VILLE>
  </SOUSFICHE>
</FB_CONTACTSFOURNISSEURS>
</FICHE>
</FB_FOURNISSEURS>

Champs Complémentaires

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.

Exemple

(VB.net)

Nom du champ = Champ Utilisateur

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""
cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID
cRetour = idev.LireTable("FB_Fournisseurs", "COMP_Champ_Utilisateur=’exemple’", " COMP_Champ_Utilisateur ASC", "1",
"0", "0")

Ignorer les champs personnalisés et calculés

Ce paramètre vous permettra d'ignorer les champs personnalisés et calculés pour une réponse plus rapide.

<_sanschampcompcalc>1</_sanschampcompcalc>

LireTableSansCData

Objectif

Similaire à la méthode LireTable, mais Il retourne um XML sans les tags “CDATA”.

Paramètre

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.

Syntaxe : <Champ> <connecteur> <Valeur> And/Or...

Ordre : l’ordre dans lequel les résultats seront affichés. (Order By). Laissez vide pour ne pas trier.

Syntaxe : <Champ> ASC/DESC

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.

Données renvoyées

Fichier XML contenant les données des tables et des sous-tables, avec code et message d’erreur en cas d’échec.

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""
cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID
cRetour = idev.LireTableSansCData("FB_Fournisseurs", "CodeFournisseur=’!!!!!!!!!!!!’", "CodeFournisseur ASC", "1", "0", "0")

Affiche (XML) :

<?xml version="1.0" encoding="utf-16"?>
<FB_FOURNISSEURS>
    <CRITERES>codefournisseur='!!!!!!!!!!!!'</CRITERES>
    <ORDRE>codefournisseur asc</ORDRE>
    <FICHE>
        <ADMIN>smr</ADMIN>
        <ADRESSE1>kfdkjfgnkajf</ADRESSE1>
        <ADRESSE2></ADRESSE2>
        <ADRESSE3></ADRESSE3>
        <CLERIB>57</CLERIB>
        <CODE></CODE>
        <CODEBANQUE>65465</CODEBANQUE>
        <CODEBICSWIFT>sgfsgfsg</CODEBICSWIFT>
        <CODEFOURNISSEUR>!!!!!!!!!!!!</CODEFOURNISSEUR>
        <CODEGUICHET>65465</CODEGUICHET>
        <COMP_COMPTABLE>401313131000</COMP_COMPTABLE>
        <CP>10500</CP>
        <DATEARCHIVAGE></DATEARCHIVAGE>
        <DATECREATION>05/08/2010 00:00:00</DATECREATION>
        <DOMICILIATION>dfgdfgdfg</DOMICILIATION>
        <EXM></EXM>
        <FAX></FAX>
        <IBAN></IBAN>
        <NOM>!!!!!!!!!!!!!!!!!!</NOM>
        <NONSOUMISTVA>True</NONSOUMISTVA>
        <NUMEROCOMPTE>65465466</NUMEROCOMPTE>
        <PAYS>FRANCE</PAYS>
        <REFFOURNISSEUR>663</REFFOURNISSEUR>
        <REGLEMENT></REGLEMENT>
        <SECTEUR></SECTEUR>
        <SOUMISTVADOM>False</SOUMISTVADOM>
        <TEL></TEL>
        <TVA_INTRA></TVA_INTRA>
        <TYPE_NONSOUMISTVA>3</TYPE_NONSOUMISTVA>
        <TYPEPAIEMENT></TYPEPAIEMENT>
        <TYPESOCIETE>0</TYPESOCIETE>
        <VILLE>Betignicourt</VILLE>
        <WEB></WEB>
        <FB_CONTACTSFOURNISSEURS>
            <SOUSFICHE>
                <ADRESSE1>kfdkjfgnkajf</ADRESSE1>
                <ADRESSE2></ADRESSE2>
                <ADRESSE3></ADRESSE3>
                <CIVILITE>Monsieur</CIVILITE>
                <CODEFOURNISSEUR>!!!!!!!!!!!!</CODEFOURNISSEUR>
                <COMMENTAIRE></COMMENTAIRE>
                <CP>99000</CP>
                <EMAIL></EMAIL>
                <FAX></FAX>
                <FONCTION></FONCTION>
                <IDENTIFIANTSKYPE></IDENTIFIANTSKYPE>
                <MOBILE></MOBILE>
                <NOM>sadfgasdf</NOM>
                <NUMEROSKYPE></NUMEROSKYPE>
                <PAYS>FRANCE</PAYS>
                <PRENOM>gasfgas</PRENOM>
                <REFCONTACT>413</REFCONTACT>
                <REFDUPLICATION>0</REFDUPLICATION>
                <TEL></TEL>
                <VILLE>Pas De La Casa</VILLE>
            </SOUSFICHE>
            <SOUSFICHE>
                <ADRESSE1>kfdkjfgnkajf</ADRESSE1>
                <ADRESSE2></ADRESSE2>
                <ADRESSE3></ADRESSE3>
                <CIVILITE></CIVILITE>
                <CODEFOURNISSEUR>!!!!!!!!!!!!</CODEFOURNISSEUR>
                <COMMENTAIRE></COMMENTAIRE>
                <CP>10500</CP>
                <EMAIL></EMAIL>
                <FAX></FAX>
                <FONCTION></FONCTION>
                <IDENTIFIANTSKYPE></IDENTIFIANTSKYPE>
                <MOBILE></MOBILE>
                <NOM>BIRDS</NOM>
                <NUMEROSKYPE></NUMEROSKYPE>
                <PAYS>FRANCE</PAYS>
                <PRENOM>BEAUTY</PRENOM>
                <REFCONTACT>499</REFCONTACT>
                <REFDUPLICATION></REFDUPLICATION>
                <TEL></TEL>
                <VILLE>Betignicourt</VILLE>
            </SOUSFICHE>
        </FB_CONTACTSFOURNISSEURS>
    </FICHE>
</FB_FOURNISSEURS>

Champs Complémentaires

Exemple

(VB.net) Nom du champ = Champ Utilisateur

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID
cRetour = idev. LireTableSansCData ("FB_Fournisseurs", "COMP_Champ_Utilisateur=’exemple’", " COMP_Champ_Utilisateur
ASC", "1", "0", "0")

MajTable

Objectif

Mettre à jour les données d’une table. Seules les données des tables avec autorisation d’accès seront mises à jour.

Paramètre

Fiche : XML avec les données de la table à mettre à jour. Les champs de clé primaire (primary Key) sont obligatoires.

Les données renvoyées

Fichier XML confirmant la mise à jour ou le code et le message d’erreur.

Champs Complémentaires

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”).

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

Dim cXml = "<?xml version=""1.0"" encoding=""utf-16""?>" & _
        "<FB_FOURNISSEURS>" & _
            "<FICHE>" & _
                "<ADMIN><![CDATA[smr]]></ADMIN>" & _
                "<ADRESSE1><![CDATA[kfdkjfgnkajf]]></ADRESSE1>" & _
                "<ADRESSE2><![CDATA[]]></ADRESSE2>" & _
                "<ADRESSE3><![CDATA[]]></ADRESSE3>" & _
                "<CLERIB><![CDATA[57]]></CLERIB>" & _
                "<CODE><![CDATA[]]></CODE>" & _
                "<CODEBANQUE><![CDATA[65465]]></CODEBANQUE>" & _
                "<CODEBICSWIFT><![CDATA[sgfsgfsg]]></CODEBICSWIFT>" & _
                "<CODEFOURNISSEUR><![CDATA[!!!!!!!!!!!!]]></CODEFOURNISSEUR>" & _
                "<CODEGUICHET><![CDATA[65465]]></CODEGUICHET>" & _
                "<COMP_COMPTABLE><![CDATA[401313131000]]></COMP_COMPTABLE>" & _
                "<CP><![CDATA[10500]]></CP>" & _
                "<DATEARCHIVAGE><![CDATA[]]></DATEARCHIVAGE>" & _
                "<DATECREATION><![CDATA[05/08/2010 00:00:00]]></DATECREATION>" & _
                "<DOMICILIATION><![CDATA[dfgdfgdfg]]></DOMICILIATION>" & _
                "<EXM><![CDATA[]]></EXM>" & _
                "<FAX><![CDATA[]]></FAX>" & _
                "<IBAN><![CDATA[]]></IBAN>" & _
                "<NOM><![CDATA[!!!!!!!!!!!!!!!!!!]]></NOM>" & _
                "<NONSOUMISTVA><![CDATA[True]]></NONSOUMISTVA>" & _
                "<NUMEROCOMPTE><![CDATA[65465466]]></NUMEROCOMPTE>" & _
                "<PAYS><![CDATA[FRANCE]]></PAYS>" & _
                "<REFFOURNISSEUR><![CDATA[663]]></REFFOURNISSEUR>" & _
                "<REGLEMENT><![CDATA[]]></REGLEMENT>" & _
                "<SECTEUR><![CDATA[]]></SECTEUR>" & _
                "<SOUMISTVADOM><![CDATA[False]]></SOUMISTVADOM>" & _
                "<TEL><![CDATA[]]></TEL>" & _
                "<TVA_INTRA><![CDATA[]]></TVA_INTRA>" & _
                "<TYPE_NONSOUMISTVA><![CDATA[3]]></TYPE_NONSOUMISTVA>" & _
                "<TYPEPAIEMENT><![CDATA[]]></TYPEPAIEMENT>" & _
                "<TYPESOCIETE><![CDATA[]]></TYPESOCIETE>" & _
                "<VILLE><![CDATA[Betignicourt]]></VILLE>" & _
                "<WEB><![CDATA[]]></WEB>" & _
	   "<COMP_ChampUtilisateur><![CDATA[exemple]]></COMP_ChampUtilisateur>" & _
            "</FICHE>" & _
        "</FB_FOURNISSEURS>"

cRetour = idev.MajTable(cXml)

Affiche (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

MajSousTable

Objectif

Mettre à jour les données d’une sous-table. Seules les données des tables avec autorisation d’accès seront mises à jour.

Paramètres

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)

Les données renvoyées

Retourne un XML confirmant la mise à jour ou le code et le message d’erreur.

Champs Complémentaires

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

Dim cXml = "<?xml version=""1.0"" encoding=""utf-16""?>" & _
        "<FB_FOURNISSEURS>" & _
            "<FICHE>" & _
                "<ADMIN><![CDATA[smr]]></ADMIN>" & _
                "<ADRESSE1><![CDATA[kfdkjfgnkajf]]></ADRESSE1>" & _
                "<ADRESSE2><![CDATA[]]></ADRESSE2>" & _
                "<ADRESSE3><![CDATA[]]></ADRESSE3>" & _
                "<CLERIB><![CDATA[57]]></CLERIB>" & _
                "<CODE><![CDATA[]]></CODE>" & _
                "<CODEBANQUE><![CDATA[65465]]></CODEBANQUE>" & _
                "<CODEBICSWIFT><![CDATA[sgfsgfsg]]></CODEBICSWIFT>" & _
                "<CODEFOURNISSEUR><![CDATA[!!!!!!!!!!!!]]></CODEFOURNISSEUR>" & _
                "<CODEGUICHET><![CDATA[65465]]></CODEGUICHET>" & _
                "<COMP_COMPTABLE><![CDATA[401313131000]]></COMP_COMPTABLE>" & _
                "<CP><![CDATA[10500]]></CP>" & _
                "<DATEARCHIVAGE><![CDATA[]]></DATEARCHIVAGE>" & _
                "<DATECREATION><![CDATA[05/08/2010 00:00:00]]></DATECREATION>" & _
                "<DOMICILIATION><![CDATA[dfgdfgdfg]]></DOMICILIATION>" & _
                "<EXM><![CDATA[]]></EXM>" & _
                "<FAX><![CDATA[]]></FAX>" & _
                "<IBAN><![CDATA[]]></IBAN>" & _
                "<NOM><![CDATA[!!!!!!!!!!!!!!!!!!]]></NOM>" & _
                "<NONSOUMISTVA><![CDATA[True]]></NONSOUMISTVA>" & _
                "<NUMEROCOMPTE><![CDATA[65465466]]></NUMEROCOMPTE>" & _
                "<PAYS><![CDATA[FRANCE]]></PAYS>" & _
                "<REFFOURNISSEUR><![CDATA[663]]></REFFOURNISSEUR>" & _
                "<REGLEMENT><![CDATA[]]></REGLEMENT>" & _
                "<SECTEUR><![CDATA[]]></SECTEUR>" & _
                "<SOUMISTVADOM><![CDATA[False]]></SOUMISTVADOM>" & _
                "<TEL><![CDATA[]]></TEL>" & _
                "<TVA_INTRA><![CDATA[]]></TVA_INTRA>" & _
                "<TYPE_NONSOUMISTVA><![CDATA[3]]></TYPE_NONSOUMISTVA>" & _
                "<TYPEPAIEMENT><![CDATA[]]></TYPEPAIEMENT>" & _
                "<TYPESOCIETE><![CDATA[]]></TYPESOCIETE>" & _
                "<VILLE><![CDATA[Betignicourt]]></VILLE>" & _
                "<WEB><![CDATA[]]></WEB>" & _
                "<FB_CONTACTSFOURNISSEURS>" & _
                    "<SOUSFICHE>" & _
                        "<ADRESSE1><![CDATA[kfdkjfgnkajf]]></ADRESSE1>" & _
                        "<ADRESSE2><![CDATA[]]></ADRESSE2>" & _
                        "<ADRESSE3><![CDATA[]]></ADRESSE3>" & _
                        "<CIVILITE><![CDATA[Monsieur]]></CIVILITE>" & _
                        "<CODEFOURNISSEUR><![CDATA[!!!!!!!!!!!!]]></CODEFOURNISSEUR>" & _
                        "<COMMENTAIRE><![CDATA[]]></COMMENTAIRE>" & _
                        "<CP><![CDATA[99000]]></CP>" & _
                        "<EMAIL><![CDATA[]]></EMAIL>" & _
                        "<FAX><![CDATA[]]></FAX>" & _
                        "<FONCTION><![CDATA[]]></FONCTION>" & _
                        "<IDENTIFIANTSKYPE><![CDATA[]]></IDENTIFIANTSKYPE>" & _
                        "<MOBILE><![CDATA[]]></MOBILE>" & _
                        "<NOM><![CDATA[sadfgasdf]]></NOM>" & _
                        "<NUMEROSKYPE><![CDATA[]]></NUMEROSKYPE>" & _
                        "<PAYS><![CDATA[FRANCE]]></PAYS>" & _
                        "<PRENOM><![CDATA[gasfgas]]></PRENOM>" & _
                        "<REFCONTACT><![CDATA[413]]></REFCONTACT>" & _
                        "<REFDUPLICATION><![CDATA[]]></REFDUPLICATION>" & _
                        "<TEL><![CDATA[]]></TEL>" & _
                        "<VILLE><![CDATA[Pas De La Casa]]></VILLE>" & _
	           "<COMP_ChampUtilisateur><![CDATA[exemple]]></ COMP_ChampUtilisateur>" & _
                    "</SOUSFICHE>" & _
                    "<SOUSFICHE>" & _
                        "<ADRESSE1><![CDATA[asasas]]></ADRESSE1>" & _
                        "<ADRESSE2><![CDATA[]]></ADRESSE2>" & _
                        "<ADRESSE3><![CDATA[]]></ADRESSE3>" & _
                        "<CIVILITE><![CDATA[Mademoiselle]]></CIVILITE>" & _
                        "<CODEFOURNISSEUR><![CDATA[!!!!!!!!!!!!]]></CODEFOURNISSEUR>" & _
                        "<COMMENTAIRE><![CDATA[aaaaaaaaaaaaaa]]></COMMENTAIRE>" & _
                        "<CP><![CDATA[01250]]></CP>" & _
                        "<EMAIL><![CDATA[sdfsf@sdf.fr]]></EMAIL>" & _
                        "<FAX><![CDATA[]]></FAX>" & _
                        "<FONCTION><![CDATA[Architecte_2187]]></FONCTION>" & _
                        "<IDENTIFIANTSKYPE><![CDATA[]]></IDENTIFIANTSKYPE>" & _
                        "<MOBILE><![CDATA[]]></MOBILE>" & _
                        "<NOM><![CDATA[WWWWWWWW]]></NOM>" & _
                        "<NUMEROSKYPE><![CDATA[]]></NUMEROSKYPE>" & _
                        "<PAYS><![CDATA[FRANCE]]></PAYS>" & _
                        "<PRENOM><![CDATA[WWWWW]]></PRENOM>" & _
                        "<REFCONTACT><![CDATA[412]]></REFCONTACT>" & _
                        "<REFDUPLICATION><![CDATA[]]></REFDUPLICATION>" & _
                        "<TEL><![CDATA[]]></TEL>" & _
                        "<VILLE><![CDATA[Bohas]]></VILLE>" & _
                    "</SOUSFICHE>" & _
                    "<SOUSFICHE>" & _
                        "<ADRESSE1><![CDATA[AAAAAAAAA]]></ADRESSE1>" & _
                        "<ADRESSE2><![CDATA[]]></ADRESSE2>" & _
                        "<ADRESSE3><![CDATA[]]></ADRESSE3>" & _
                        "<CIVILITE><![CDATA[Monsieur]]></CIVILITE>" & _
                        "<CODEFOURNISSEUR><![CDATA[!!!!!!!!!!!!]]></CODEFOURNISSEUR>" & _
                        "<COMMENTAIRE><![CDATA[sdafsdfdsf]]></COMMENTAIRE>" & _
                        "<CP><![CDATA[01090]]></CP>" & _
                        "<EMAIL><![CDATA[]]></EMAIL>" & _
                        "<FAX><![CDATA[]]></FAX>" & _
                        "<FONCTION><![CDATA[]]></FONCTION>" & _
                        "<IDENTIFIANTSKYPE><![CDATA[]]></IDENTIFIANTSKYPE>" & _
                        "<MOBILE><![CDATA[]]></MOBILE>" & _
                        "<NOM><![CDATA[!!!!!!!!!!!]]></NOM>" & _
                        "<NUMEROSKYPE><![CDATA[]]></NUMEROSKYPE>" & _
                        "<PAYS><![CDATA[FRANCE]]></PAYS>" & _
                        "<PRENOM><![CDATA[!!!!!!!!!!!!!!]]></PRENOM>" & _
                        "<REFCONTACT><![CDATA[411]]></REFCONTACT>" & _
                        "<REFDUPLICATION><![CDATA[]]></REFDUPLICATION>" & _
                        "<TEL><![CDATA[]]></TEL>" & _
                        "<VILLE><![CDATA[Amareins Francheleins Cesseins]]></VILLE>" & _
                    "</SOUSFICHE>" & _
                "</FB_CONTACTSFOURNISSEURS>" & _
            "</FICHE>" & _
        "</FB_FOURNISSEURS>"

cRetour = idev.MajSousTable(cXml, "FB_ContactsFournisseurs", "Nom", "Prenom")

Affiche (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

InsererTable

Objectif

Insérer les données dans une table. Seules les données des tables avec autorisation d’accès seront insérées.

Paramètres

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.

Les données renvoyées

Retourne un XML en confirmant la mise à jour ou le code et le message d’erreur.

Champs Complémentaires

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”).

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

Dim cXml = "<?xml version=""1.0"" encoding=""utf-16""?>" & _
"<FB_FOURNISSEURS>" & _
    "<FICHE>" & _
        "<ADMIN><![CDATA[asybesaw]]></ADMIN>" & _
        "<ADRESSE1><![CDATA[A]]></ADRESSE1>" & _
        "<ADRESSE2><![CDATA[2]]></ADRESSE2>" & _
        "<ADRESSE3><![CDATA[3]]></ADRESSE3>" & _
        "<CLERIB><![CDATA[4]]></CLERIB>" & _
        "<CODE><![CDATA[5]]></CODE>" & _
        "<CODEBANQUE><![CDATA[6]]></CODEBANQUE>" & _
        "<CODEBICSWIFT><![CDATA[7]]></CODEBICSWIFT>" & _
        "<CODEFOURNISSEUR><![CDATA[REV000303Z1]]></CODEFOURNISSEUR>" & _
        "<CODEGUICHET><![CDATA[8]]></CODEGUICHET>" & _
        "<COMP_COMPTABLE><![CDATA[9]]></COMP_COMPTABLE>" & _
        "<CP><![CDATA[df]]></CP>" & _
        "<DATEARCHIVAGE><![CDATA[10/10/2004]]></DATEARCHIVAGE>" & _
        "<DATECREATION><![CDATA[11/10/2004 00:00:00]]></DATECREATION>" & _
        "<DOMICILIATION><![CDATA[]]></DOMICILIATION>" & _
        "<EXM><![CDATA[]]></EXM>" & _
        "<FAX><![CDATA[]]></FAX>" & _
        "<IBAN><![CDATA[]]></IBAN>" & _
        "<NOM><![CDATA[dfg]]></NOM>" & _
        "<NONSOUMISTVA><![CDATA[]]></NONSOUMISTVA>" & _
        "<NUMEROCOMPTE><![CDATA[]]></NUMEROCOMPTE>" & _
        "<PAYS><![CDATA[dfgfg]]></PAYS>" & _
        "<REFFOURNISSEUR><![CDATA[35]]></REFFOURNISSEUR>" & _
        "<REGLEMENT><![CDATA[]]></REGLEMENT>" & _
        "<SECTEUR><![CDATA[]]></SECTEUR>" & _
        "<SOUMISTVADOM><![CDATA[1]]></SOUMISTVADOM>" & _
        "<TEL><![CDATA[aaa]]></TEL>" & _
        "<TVA_INTRA><![CDATA[df]]></TVA_INTRA>" & _
        "<TYPE_NONSOUMISTVA><![CDATA[]]></TYPE_NONSOUMISTVA>" & _
        "<TYPEPAIEMENT><![CDATA[]]></TYPEPAIEMENT>" & _
        "<TYPESOCIETE><![CDATA[]]></TYPESOCIETE>" & _
        "<VILLE><![CDATA[aaa]]></VILLE>" & _
        "<WEB><![CDATA[]]></WEB>" & _
        "<COMP_ChampUtilisateur><![CDATA[exemple]]></COMP_ChampUtilisateur>" & _
    "</FICHE>" & _
    "<FICHE>" & _
        "<ADMIN><![CDATA[asybesaw]]></ADMIN>" & _
        "<ADRESSE1><![CDATA[B]]></ADRESSE1>" & _
        "<ADRESSE2><![CDATA[2]]></ADRESSE2>" & _
        "<ADRESSE3><![CDATA[3]]></ADRESSE3>" & _
        "<CLERIB><![CDATA[4]]></CLERIB>" & _
        "<CODE><![CDATA[5]]></CODE>" & _
        "<CODEBANQUE><![CDATA[6]]></CODEBANQUE>" & _
        "<CODEBICSWIFT><![CDATA[7]]></CODEBICSWIFT>" & _
        "<CODEFOURNISSEUR><![CDATA[REV000303Z2]]></CODEFOURNISSEUR>" & _
        "<CODEGUICHET><![CDATA[8]]></CODEGUICHET>" & _
        "<COMP_COMPTABLE><![CDATA[9]]></COMP_COMPTABLE>" & _
        "<CP><![CDATA[df]]></CP>" & _
        "<DATEARCHIVAGE><![CDATA[10/10/2004]]></DATEARCHIVAGE>" & _
        "<DATECREATION><![CDATA[11/10/2004 00:00:00]]></DATECREATION>" & _
        "<DOMICILIATION><![CDATA[]]></DOMICILIATION>" & _
        "<EXM><![CDATA[]]></EXM>" & _
        "<FAX><![CDATA[]]></FAX>" & _
        "<IBAN><![CDATA[]]></IBAN>" & _
        "<NOM><![CDATA[dfg]]></NOM>" & _
        "<NONSOUMISTVA><![CDATA[1]]></NONSOUMISTVA>" & _
        "<NUMEROCOMPTE><![CDATA[]]></NUMEROCOMPTE>" & _
        "<PAYS><![CDATA[dfgfg]]></PAYS>" & _
        "<REFFOURNISSEUR><![CDATA[35]]></REFFOURNISSEUR>" & _
        "<REGLEMENT><![CDATA[]]></REGLEMENT>" & _
        "<SECTEUR><![CDATA[]]></SECTEUR>" & _
        "<SOUMISTVADOM><![CDATA[1]]></SOUMISTVADOM>" & _
        "<TEL><![CDATA[aaa]]></TEL>" & _
        "<TVA_INTRA><![CDATA[df]]></TVA_INTRA>" & _
        "<TYPE_NONSOUMISTVA><![CDATA[]]></TYPE_NONSOUMISTVA>" & _
        "<TYPEPAIEMENT><![CDATA[]]></TYPEPAIEMENT>" & _
        "<TYPESOCIETE><![CDATA[]]></TYPESOCIETE>" & _
        "<VILLE><![CDATA[aaa]]></VILLE>" & _
        "<WEB><![CDATA[]]></WEB>" & _
        "<COMP_ChampUtilisateur><![CDATA[exemple]]></COMP_ChampUtilisateur>" & _
    "</FICHE>" & _
    "<FICHE>" & _
        "<ADMIN><![CDATA[asybesaw]]></ADMIN>" & _
        "<ADRESSE1><![CDATA[C]]></ADRESSE1>" & _
        "<ADRESSE2><![CDATA[2]]></ADRESSE2>" & _
        "<ADRESSE3><![CDATA[3]]></ADRESSE3>" & _
        "<CLERIB><![CDATA[4]]></CLERIB>" & _
        "<CODE><![CDATA[5]]></CODE>" & _
        "<CODEBANQUE><![CDATA[6]]></CODEBANQUE>" & _
        "<CODEBICSWIFT><![CDATA[7]]></CODEBICSWIFT>" & _
        "<CODEFOURNISSEUR><![CDATA[REV000303Z3]]></CODEFOURNISSEUR>" & _
        "<CODEGUICHET><![CDATA[8]]></CODEGUICHET>" & _
        "<COMP_COMPTABLE><![CDATA[9]]></COMP_COMPTABLE>" & _
        "<CP><![CDATA[df]]></CP>" & _
        "<DATEARCHIVAGE><![CDATA[10/10/2004]]></DATEARCHIVAGE>" & _
        "<DATECREATION><![CDATA[11/10/2004 00:00:00]]></DATECREATION>" & _
        "<DOMICILIATION><![CDATA[]]></DOMICILIATION>" & _
        "<EXM><![CDATA[]]></EXM>" & _
        "<FAX><![CDATA[]]></FAX>" & _
        "<IBAN><![CDATA[]]></IBAN>" & _
        "<NOM><![CDATA[dfg]]></NOM>" & _
        "<NONSOUMISTVA><![CDATA[0]]></NONSOUMISTVA>" & _
        "<NUMEROCOMPTE><![CDATA[]]></NUMEROCOMPTE>" & _
        "<PAYS><![CDATA[dfgfg]]></PAYS>" & _
        "<REFFOURNISSEUR><![CDATA[35]]></REFFOURNISSEUR>" & _
        "<REGLEMENT><![CDATA[]]></REGLEMENT>" & _
        "<SECTEUR><![CDATA[]]></SECTEUR>" & _
        "<SOUMISTVADOM><![CDATA[1]]></SOUMISTVADOM>" & _
        "<TEL><![CDATA[aaa]]></TEL>" & _
        "<TVA_INTRA><![CDATA[df]]></TVA_INTRA>" & _
        "<TYPE_NONSOUMISTVA><![CDATA[]]></TYPE_NONSOUMISTVA>" & _
        "<TYPEPAIEMENT><![CDATA[]]></TYPEPAIEMENT>" & _
        "<TYPESOCIETE><![CDATA[]]></TYPESOCIETE>" & _
        "<VILLE><![CDATA[aaa]]></VILLE>" & _
        "<WEB><![CDATA[]]></WEB>" & _
        "<COMP_ChampUtilisateur><![CDATA[exemple]]></COMP_ChampUtilisateur>" & _
    "</FICHE>" & _
"</FB_FOURNISSEURS>"

cRetour = idev.InsererTable(cXml)

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

SuppressionTable

Objectif

Supprimer les données d’une table. Seules les données des tables avec autorisation d’accès seront supprimées.

Paramètres

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.

Les données renvoyées

Affiche un XML en confirmant que l’enregistrement a été supprimé ou avec le code et le message d’erreur.

Champs complémentaires

Les données enregistrées dans les champs complémentaires seront également supprimées.

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.SuppressionTable("FB_Fournisseurs", "REV000303Z1")

Affiche (XML)

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

CP_ PurgerGrilleSaisie

Objectif

Purger les écritures de la comptabilité existant dans les grilles de saisie.

Les données renvoyées

Retourne un XML en confirmant la suppression des écritures ou affichant le code et le message d’erreur.

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.CP_PurgerGrilleSaisie()

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

CP_ValiderGrilleSaisie

Objectif

Valider les écritures de la comptabilité existant dans les grilles de saisie.

Paramètres

Action : “1” pour brouillard, “2” pour écritures.
Rapide : “0” pour grille de saisie en vrac, “1” pour grille de saisie rapide en vrac.

Les données renvoyées

Retourne un XML en confirmant la validation des écritures ou affichant le code et le message d’erreur.

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.CP_ValiderGrilleSaisie("2", "1")

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

GC_ValiderPiece

Objectif

Valider les pièces commerciales existant dans la gestion commerciale.

Paramètres

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.

Les données renvoyées

Retourne un XML en confirmant la validation de la pièce commerciale ou le code et message d’erreur.

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.GC_ValiderPiece("FA_FACTURES", "048")

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

DefinirModule

Objectif

Permet à l'utilisateur de modifier la base de données en fonction du module à utiliser.

Paramètres

CodeModule : préfixe du module à utiliser.

Les données renvoyées

Cette méthode ne renvoie pas de données.

Commentaires

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".

Exemple (VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""
cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID
idev.DefinirModule(“FA”)
cRetour = idev.LireTable("FB_Fournisseurs", "COMP_Champ_Utilisateur=’exemple’", " COMP_Champ_Utilisateur ASC", "1",
"0", "0")

GC_ValiderImportPartenaires

Objectif

Valider les lignes existant dans les grilles d’imports partenaires sur la gestion commerciale (ventes et achats).

Paramètres

TypeImportation : “V” pour ventes, “A” pour achats.
TypePiece : “0” pour générer des factures, “1” pour générer des commandes.

Les données renvoyées

Retourne un XML en confirmant la validation des écritures ou affichant le code et le message d’erreur.

Exemple

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.GC_ValiderImportPartenaires("V", 0);

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
 <message>ok</message>
</success>

GC_Synchronisation

Objectif

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.

Paramètres

cCode : code de la synchronisation paramétrée chez Dailybiz.
dDateSynchronisation : date de référence à partir de laquelle la synchronisation ira chercher les données créées ou modifiées depuis l’API tiers.
cListeSynchronisation : liste des entités à synchroniser, séparées par virgule, sur l’application ciblé. Actuellement disponible pour l’application DailyApps - bon d'intervention uniquement.

Liste des entités possibles sur l’application DailyApps - bon d'intervention :

Les données renvoyées

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)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.GC_SynchronisationJSON("SHOP", "01/04/2022")

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
         <reftraitement>43908</reftraitement>
         <message>La synchronisation Shopify a été bien lancée.</message>
</success>

GC_VerificationSynchronisation

Objectif

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.

Paramètres

RefTraitement : c’est un identificateur numérique pour référencer le traitement en cours d'exécution.
Annuler : permet d’annuler le traitement de la synchronisation en cours.

Les données renvoyées

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)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.GC_VerificationSynchronisation(43908, False)

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<verification>
           <reftraitement>43910</reftraitement>
           <codeerreur>0</ codeerreur>
           <message>
Clients sur Bon d'intervention vers Dailybiz : 5
Contacts sur Bon d'intervention vers Dailybiz : 0
Familles d`articles sur Bon d`intervention vers Dailybiz : 0
Articles sur Bon d'intervention vers Dailybiz : 12
Dépôts sur Bon d'intervention vers Dailybiz : 0
Numéros de séries sur Bon d'intervention vers Dailybiz : 9
La synchronisation s'est terminée avec succès.
         </message>
         <progression>100</progression>
         <termine>True</termine>
</verification>

GC_Syn

GC_Synchronisation

Objectif

Paramètres

cCode : code de la synchronisation paramétrée chez Dailybiz.
dDateSynchronisation : date de référence à partir de laquelle la synchronisation ira chercher les données créées ou modifiées depuis l’API tiers.
cListeSynchronisation : liste des entités à synchroniser, séparées par virgule, sur l’application ciblé. Actuellement disponible pour l’application DailyApps - bon d'intervention uniquement.

Liste des entités possibles sur l’application DailyApps - bon d'intervention :

Les données renvoyées

Exemple :

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.GC_SynchronisationJSON("SHOP", "01/04/2022")

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<success>
         <reftraitement>43908</reftraitement>
         <message>La synchronisation Shopify a été bien lancée.</message>
</success>

CR_SoldeCompteur

Objectif

Renvoyer les informations d'un compteur CRM.

Paramètres

RefListe : Indiquer la référence de la liste de contacts (CR_Listes) interrogée.
CodeFiche : Indiquer le code la fiche pour laquelle obtenir le ou les compteurs.

Les données renvoyées

Exemple :

(VB.net)

Dim idev As New com.idylis.exe.Idylisapi()
Dim cSessionID As String = ""
Dim cRetour As String = ""

cSessionID = idev.authentification1("codeAbonne", "identifiant", "motDePasse")
idev.SessionIDHeaderValue = New com.idylis.exe.SessionIDHeader
idev.SessionIDHeaderValue.SessionID = cSessionID

cRetour = idev.CR_SoldeCompteur("-1", "ALPHA")

Retourne (XML) :

<?xml version="1.0" encoding="utf-16"?>
<Compteurs>
    <CLE><![CDATA[CPT_ACTIONS_26092017]]>
        <VALUE><CodeCompteur><![CDATA[CPT_ACTIONS]]></CodeCompteur><Descr><![CDATA[Compteurs d'actions]]></Descr><Histo><![CDATA[0]]></Histo><Solde><![CDATA[-2,00]]></Solde><DateDebut><![CDATA[26/09/2017]]></DateDebut><DateFin><![CDATA[26/09/2017]]></DateFin><Increment><![CDATA[0,00]]></Increment></VALUE>
    </CLE>
    <CLE><![CDATA[TICKET_AT_22042022]]>
        <VALUE><CodeCompteur><![CDATA[TICKET_AT]]></CodeCompteur><Descr><![CDATA[Ticket assistance technique]]></Descr><Histo><![CDATA[1]]></Histo><Solde><![CDATA[99,00]]></Solde><DateDebut><![CDATA[22/04/2022]]></DateDebut><DateFin><![CDATA[22/05/2022]]></DateFin><Increment><![CDATA[100,00]]></Increment></VALUE>
    </CLE>
    <CLE><![CDATA[TICKET_AT_22062021]]>
        <VALUE><CodeCompteur><![CDATA[TICKET_AT]]></CodeCompteur><Descr><![CDATA[Ticket assistance technique]]></Descr><Histo><![CDATA[0]]></Histo><Solde><![CDATA[0,00]]></Solde><DateDebut><![CDATA[22/06/2021]]></DateDebut><DateFin><![CDATA[22/07/2021]]></DateFin><Increment><![CDATA[0,00]]></Increment></VALUE>
    </CLE>
</Compteurs>

Méthodes API PHP

Exemples utilisant l'ensemble des méthodes de l'API

Introduction

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

Pour commencer

Prérequis

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.

Utiliser l’exemple

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.

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 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.

Exemple :
http://localhost/dossierexemplesphp/Authentification1.php

Aperçu du code

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

Exemple :
$oWS= new SoapClient("http://exe.idylis.com/idylisapi.asmx?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.

Exemple :
$oSession=$oWS->authentification1(array('_codeAbonne'=>'MonCodeAbonné', '_identifiant'=>'MonIdentifiant', '_motdePasse'=>'MonMotDePasse'))

Exemple :
$oAuth['SessionID']= $oSession->AuthentificationAvec3Parametres1Result;
$oHeader= new SoapHeader('https://www.idylis.com/Idylisapi.asmx/','SessionIDHeader',$oAuth, false);
$oWS->__setSoapHeaders(array($oHeader));

Après ces instructions initiales, vous trouverez l’appel à la méthode qui est l’objet de l’exemple.

Exemple :
Lecture de la table fournisseurs :
$oRes=$oWS->LireTable(array('_nomtable'=>"FB_Fournisseurs", '_criteres'=>"", '_ordre'=>"", '_soustables'=>"0", '_pieceatache'=>"0", '_aveccompression'=>"0"))

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.

On instancie la classe SimpleXML en passant en paramètre la réponse du service web.

Exemple :
$oResXML= new SimpleXMLElement($oRes->LireTableResult);

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 :

<NOM_TABLE><CRITERES></CRITERES><ORDRE></ORDRE><FICHE><CHAMP1>valeur</ CHAMP1><CHAMP2>valeur</ CHAMP2></FICHE></NOM_TABLE>

La réponse rappelle le nom de la table lue ainsi que les critères et l’ordre utilisés.

On peut afficher le contenu de la table en parcourant le tableau «FICHE» ou en atteignant directement un élément.

Exemple :
Pour  afficher  la  raison  sociale  du  premier  enregistrement  retourné  pour  la  table fournisseurs :
echo $oResXML->FICHE[0]->NOM;

Pour afficher les valeurs des champs «Code fournisseur», «Nom», «Adresse1» pour tous les enregistrements retournés de la table fournisseurs :

foreach ($oResXML->FICHE as $valeur){
echo 'Code Fournisseur : '.$valeur->CODEFOURNISSEUR.'<br>';
echo 'Raison Sociale : '.$valeur->NOM.'<br>';
echo 'Adresse 1 : '.$valeur->ADRESSE1.'<br>';
}

Télécharger l'exemple

16KB

MethodesAPI_PHP.zip