> For the complete documentation index, see [llms.txt](https://docs.dailybiz.com/index/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dailybiz.com/index/dev-center-api-dev-center-api/manuel-dutilisation-api/sdk-exemples-dutilisation/methodes-api-php.md). # methodes-api-php ## 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: ) : * 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 : ``` valeurvaleur ``` La réponse rappelle le nom de la table lue ainsi que les critères et l’ordre utilisés. La balise \ 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 \, 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.'
'; echo 'Raison Sociale : '.$valeur->NOM.'
'; echo 'Adresse 1 : '.$valeur->ADRESSE1.'
'; } ``` ## Télécharger l'exemple {% file src="/files/oZZrQeJxAmAXQBmV5hCO" %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.dailybiz.com/index/dev-center-api-dev-center-api/manuel-dutilisation-api/sdk-exemples-dutilisation/methodes-api-php.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.