Comment créer un fichier .qwc pour QuickBooks Web Connector?

Question

J'intègre QuickBooks (version de bureau) avec une application ASP.NET. Pour cela j'utilise QuickBooks Web Connector. Comment puis-je créer un fichier .qwc pour mon service Web personnalisé?

Answer 1

Le connecteur Web est vraiment juste un proxy ou un relais qui se trouve entre QuickBooks et votre propre application.

En résumé, vous créez un serveur/service Web SOAP qui décrit un ensemble spécifique de méthodes. Le Web Connector est alors installé sur la machine exécutant QuickBooks, et interroge votre service web en demandant "Hey, avez-vous quelque chose à faire?" Votre service web peut alors répondre avec des requêtes qbXML (examples of qbXML here) qui indiquent au Web Connector "Ajouter ce client : ... "ou" Envoyez-moi des factures qui correspondent: ... "ou etc. etc. etc. Le connecteur Web transmet ensuite ces demandes à QuickBooks, QuickBooks les traite et la réponse est transmise à votre service Web. Votre service Web peut ensuite traiter la réponse d'une manière ou d'une autre, puis envoyer la demande suivante au connecteur Web.

Il y a un plus grand overview of the Web Connector here ou, si vous téléchargez le QuickBooks SDK il a un PDF de plus de 100 pages qui va dans le détail.

Vous voulez probablement aussi regarder cet exemple après l'installation du SDK QuickBooks:

• C: \ Program Files (x86) \ Intuit \ IDN \ QBSDK12.0 \ samples \ qbdt \ dièse \ qbXML \ WCWebService

Ce qui est un exemple complet d'une implémentation SOAP de Web Connector.

à sa forme la plus basique, il ressemble à quelque chose comme ceci:

[WebMethod] 
    /// <summary> 
    /// WebMethod - authenticate() 
    /// To verify username and password for the web connector that is trying to connect 
    /// Signature: public string[] authenticate(string strUserName, string strPassword) 
    /// 
    /// IN: 
    /// string strUserName 
    /// string strPassword 
    /// 
    /// OUT: 
    /// string[] authReturn 
    /// Possible values: 
    /// string[0] = ticket 
    /// string[1] 
    /// - empty string = use current company file 
    /// - "none" = no further request/no further action required 
    /// - "nvu" = not valid user 
    /// - any other string value = use this company file 
    /// </summary> 
    public string[] authenticate(string strUserName, string strPassword) 
    { 
     string[] authReturn = new string[2]; 

     // Generate a random session ticket 
     authReturn[0]= System.Guid.NewGuid().ToString(); 

     // For simplicity of sample, a hardcoded username/password is used. 
     string pwd="password"; 

     if (strUserName.Trim().Equals("username") && strPassword.Trim().Equals(pwd)) 
     { 
      // An empty string for authReturn[1] means asking QBWebConnector 
      // to connect to the company file that is currently openned in QB 
      authReturn[1]=""; 
     } 
     else 
     { 
      authReturn[1]="nvu"; 
     } 

     return authReturn; 
    } 

    [ WebMethod(Description="This web method facilitates web service to send request XML to QuickBooks via QBWebConnector",EnableSession=true) ] 
    /// <summary> 
    /// WebMethod - sendRequestXML() 
    /// Signature: public string sendRequestXML(string ticket, string strHCPResponse, string strCompanyFileName, 
    /// string Country, int qbXMLMajorVers, int qbXMLMinorVers) 
    /// 
    /// IN: 
    /// int qbXMLMajorVers 
    /// int qbXMLMinorVers 
    /// string ticket 
    /// string strHCPResponse 
    /// string strCompanyFileName 
    /// string Country 
    /// int qbXMLMajorVers 
    /// int qbXMLMinorVers 
    /// 
    /// OUT: 
    /// string request 
    /// Possible values: 
    /// - “any_string” = Request XML for QBWebConnector to process 
    /// - "" = No more request XML 
    /// </summary> 
    public string sendRequestXML(string ticket, string strHCPResponse, string strCompanyFileName, 
     string qbXMLCountry, int qbXMLMajorVers, int qbXMLMinorVers) 
    { 
     // QuickBooks has asked for your next request 

     ... return a qbXML request here ... 
    } 

    [ WebMethod(Description="This web method facilitates web service to receive response XML from QuickBooks via QBWebConnector",EnableSession=true) ] 
    /// <summary> 
    /// WebMethod - receiveResponseXML() 
    /// Signature: public int receiveResponseXML(string ticket, string response, string hresult, string message) 
    /// 
    /// IN: 
    /// string ticket 
    /// string response 
    /// string hresult 
    /// string message 
    /// 
    /// OUT: 
    /// int retVal 
    /// Greater than zero = There are more request to send 
    /// 100 = Done. no more request to send 
    /// Less than zero = Custom Error codes 
    /// </summary> 
    public int receiveResponseXML(string ticket, string response, string hresult, string message) 
    { 
     // QuickBooks has sent you a qbXML response to your request 

     ... do something with 'response' here ... 
    } 

Cet exemple comprend également un exemple de fichier .QWC. Here's some .QWC file documentation et voici un exemple de base:

<?xml version="1.0"?> 
<QBWCXML> 
    <AppName>QuickBooks Integrator</AppName> 
    <AppID></AppID> 
    <AppURL>https://secure.domain.com/quickbooks/server.php</AppURL> 
    <AppDescription></AppDescription> 
    <AppSupport>http://www.domain.com/quickbooks/support.php</AppSupport> 
    <UserName>username</UserName> 
    <OwnerID>{90A44FB7-33D9-4815-AC85-AC86A7E7D1EB}</OwnerID> 
    <FileID>{57F3B9B6-86F1-4FCC-B1FF-967DE1813D20}</FileID> 
    <QBType>QBFS</QBType> 
    <Scheduler> 
     <RunEveryNMinutes>2</RunEveryNMinutes> 
    </Scheduler> 
    <IsReadOnly>false</IsReadOnly> 
</QBWCXML>