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:

1. Télécharger l’archive

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

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

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

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.

La première méthode sert à vous authentifier.

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

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.

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

L’appel à méthode DefinirModule permet de vous connecter à la bonne base de données pour exécuter les méthodes suivantes.

Exemple :
$oWS->DefinirModule(array('_codemodule'=>'FA'));

On charge le fichier XML contenant les données à importer en mémoire avec la méthode load de la classe DOMDocument.

Exemple :
$oFichierXML= new DOMDocument();
$oFichierXML->load('ImportXML.xml');

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.

Exemple :
$oWS->InsererTable(array('_cFiche'=>$oFichierXML->saveXML()));

Télécharger l'exemple

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 :

1. Télécharger l’archive

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

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.

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

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.

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.

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.

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.

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