Как создать файл.qwc для QuickBooks Web Connector?

Question

Я интегрирую QuickBooks (настольная версия) с приложением ASP.NET. Для этого я использую QuickBooks Web Connector. Как я могу создать файл.qwc для своего пользовательского веб-сервиса?

Answer 1

Web Connector - это просто прокси или ретранслятор, который находится между QuickBooks и вашим собственным приложением.

В качестве обзора - в основном, вы создаете сервер / веб-сервис SOAP, который говорит с определенным набором методов. Затем Web Connector устанавливается на компьютере, на котором запущены QuickBooks, и опрашивает ваш веб-сервис, спрашивая: "Эй, у меня есть что-то, что я могу сделать?". Ваш веб-сервис может затем отвечать запросами qbXML ( примеры qbXML здесь), которые сообщают Web Connector: Добавьте этого клиента: … "или" Отправьте мне счета, которые соответствуют: … "или т. Д. И т. Д. И т. Д. И т. Д. Затем Web Connector передает эти запросы в QuickBooks, QuickBooks обрабатывает их, и ответ возвращается в веб-службу. Затем ваш веб-сервис может как-то обработать ответ, а затем отправить следующий запрос в Web Connector.

Здесь представлен более подробный обзор Web Connector, или, если вы загрузите QuickBooks SDK, он содержит более 100 страниц PDF-файла, в котором подробно об этом говорится.

Вы, вероятно, также захотите взглянуть на этот пример после установки QuickBooks SDK:

• C: \ Program Files (x86) \ Intuit \ IDN \ QBSDK12.0 \ samples \ qbdt \ c-sharp \ qbXML \ WCWebService

Это полный рабочий пример реализации SOAP Web Connector.

В своей основной форме это выглядит примерно так:

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

Этот пример также включает в себя пример файла.QWC. Вот некоторая документация файла.QWC и вот основной пример:

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