SOAP

    Génération

    Le service AuthenticationWSService expose l’opération login

    POST /core/services/authentication

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:aut="http://flower.com/docs/ws/api/authentication">
       <soapenv:Header/>
       <soapenv:Body>
          <aut:loginRequest>
             <aut:scope>GEC</aut:scope>
             <aut:user>user</aut:user>
             <aut:password>password</aut:password>
          </aut:loginRequest>
       </soapenv:Body>
    </soapenv:Envelope>
    

    Utilisation

    Pour authentifier un client, le jeton doit être fourni à chaque requête. Il fourni sous la forme d’une en-tête SOAP sous le namespace flower.

    • Commencer par définir le namespace flower :

          xmlns:flower="flower"
      
    • Ajouter l’en-tête à l’enveloppe SOAP :

      <soapenv:Header>    
          <flower:token><token></flower:token>
      <soapenv:Header>
          
      

    Afin de créer un document, le service DocumentWSService expose une opération create

    POST /core/services/document

    	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    	xmlns:doc="http://flower.com/docs/ws/api/document" 
    	xmlns:doc1="http://flower.com/docs/domain/document"
    	xmlns:com="http://flower.com/docs/domain/component"
    	xmlns:com1="http://flower.com/docs/domain/common" 
    	xmlns:acl="http://flower.com/docs/domain/acl" 
    	xmlns:file="http://flower.com/docs/domain/file" 
    	xmlns:flower="flower" >
    	   <soapenv:Header>
    	    <flower:token>{{token}}</flower:token>
    	   </soapenv:Header>
    	   <soapenv:Body>
    	      <doc:createRequest>
    	         <doc1:Document category="DOCUMENT" name="Mon document">
    	            <com:data>
    	               <com:classId>GEC_Courrier</com:classId>
    	            </com:data>
    	             <com:Tags>
    	               <com:tags name="GEC_AdresseDestinataire">
    	                  <com:value>destinataire@gmail.com</com:value>
    	               </com:tags>
    	            </com:Tags>
    	            <doc1:files>
    	              <file:Name>FileName</file:Name>
    	              <file:Content>cid:200566171966</file:Content>
    	            </doc1:files>
    	         </doc1:Document>
    	      </doc:createRequest>
    	   </soapenv:Body>
    	</soapenv:Envelope>
    
    

    Le service /core/services/documentMTOM fourni les mêmes opérations et supporte le MTOM pour le transfert des contenus. L’utilisation de ce service est recommandé pour la création de document avec des contenus de taille conséquente.

    Afin de rechercher des documents, le service DocumentWSService expose une opération search.

    POST /core/services/document

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:doc="http://flower.com/docs/ws/api/document" 
    xmlns:sear="http://flower.com/docs/domain/search"
    xmlns:flower="flower" >
       <soapenv:Header>
      <flower:token>{{token}}</flower:token>
       </soapenv:Header>
       <soapenv:Body>
          <doc:searchRequest>
              <doc:search>
            	<sear:filterClauses xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="sear:AndClause">
            		<sear:criteria>
    		          <sear:name>name</sear:name>
    		          <sear:operator>CONTAINS</sear:operator>
    		          <sear:type>STRING</sear:type>
    		          <sear:values>facture</sear:values>
    		       </sear:criteria>
            	</sear:filterClauses>
                <sear:start>0</sear:start>
                <sear:max>10</sear:max>
             </doc:search>
          </doc:searchRequest>
       </soapenv:Body>
    </soapenv:Envelope>
    

    Les WSDL définissent le contrat de service des web services SOAP exposés par Flower Core.

    Ils sont exposés ici.