Visma Nova Webservice Version 1.1 /

Transcription

1 Visma Nova Webservice Version 1.1 /

2 reserves all rights to possible improvements and/or changes in this manual and/or program without a separate notice. Copying of this manual and other material connected with it is forbidden without a written permission of. Microsoft, MS, SQL Server, Microsoft Word and Windows are registered trademarks of Microsoft Corporation., 2017

3 Table of contents 1 Introduction Nova WebService and Nova environment overview About the integration project General requirements To do before the installation Using Nova Webservice API Test with Boomerang Execute Execute page 1

4 1 Introduction This document contains the installation- and user manual. The XML-description can be found in a separate document. For support please contact: novasdksupport@visma.com 1.1 Nova WebService and Nova environment overview Nova Webservice is installed to Windows server in the Nova customer s environment, where IIS (Internet Information Services) is installed and the server must have access to Nova s database server (SQL server). During the installation of Webservice a unique key is created and the 3rd party can connect to a specified Nova company database with that key. The customer has to tell from which address the Webservice is replying from (for example: Webservice is used by sending an xml message with the execute method and Webservice replies with a return xml-message. The 3rd party is responsible for creating the application, which then uses Nova webservice API. NOTE! Customer is responsible for the IIS settings. page 2

5 1.2 About the integration project All integration projects should start with specifications, where the party who ordered the integration and the one creating it decide together on the content of the integration project what functionalities and restrictions it will include. The parties should also make sure that the Webservice API provides the components needed for the integration. We recommend having the specifications in writing. To test the implementation phase of the integration it is recommended to have a test environment as similar as possible to the production environment. This way you can test and identify the different scenarios. The integration will be deployed to production only after all usage scenarios have been tested and accepted as planned in the test environment similar to production. You can also ask our consultant to be part of the implementation process. For more information, contact the Visma salesperson responsible for your company. page 3

6 2 General requirements 1. Windows server: Windows Server 2008 R Net 4.5 full 3. IIS installed on the server 4. Server has a public IP 5. The firewall settings have to be settled between the integrator and the customer. Webservice uses ports 80 (http) or 443 (https). We recommend to use HTTPS protocol. 6. Admin access rights for the user who makes the installation 3 To do before the installation Latest Nova-version has to be installed. IIS must be installed before installing Webservice. In IIS, the following defaults have to be selected: - Application Development o.net Extensibility 3.5 o.net Extensibility 4.5: o ASP.NET 3.5 HTTP Activation o ASP.NET 4.5 WCF Services HTTP Activation - Management Tools o IIS Management Scripts and Tools page 4

7 - ISAPI and CGI restrictions: asp.net 4.0 version has to be allowed page 5

8 NOTE! Make sure that you have appropriate access rights to perform the installation. The majority of problems during installation is due to limited access rights. page 6

9 3.1 Using Nova Webservice API Visma Nova Webservice follows the SOAP-model and contains the following webmethods: Execute ExecuteEx HelloWorld SDKVersion WebServiceVersion Main method which is used to send XML-messages to Webservice. Returns an xml-message. Not in use Test method Returns NovaSDK s version number, which is used by Webservice Returns the version number of Webservice An XML-message is sent to Webservice using the Execute-method, which consists of two parts: the Login part and the method part. The login part is used to specify which connection you want to use. You will get the keys required in the Login part from the person who installed Webservice. In the example, the <hash> element inside the <Login> tag specifies the key which is used. <?xml version="1.0" encoding="utf-8"?> <xml> <login> <hash dsn="nova">73685dbea b74a3a2e9c1c3ecc</hash> </login> <ReadArticle> <ArticleCode>tuote1</ArticleCode> </ReadArticle> </xml> The actual task that you want to accomplish with the execute-method is shown in the following example: <ReadArticle> <ArticleCode>tuote1</ArticleCode> </ReadArticle> The execute -method returns the xml message. You can find examples and descriptions of these functions in a separate document. Here is an example in vb.net: an order is created with Nova webservice: Dim xmltext As String = "<?xml version=""1.0"" encoding=""utf-8""?> <xml> <login> <hash dsn=""nova"">73685dbea b74a3a2e9c1c3ecc</hash> </login> <SalesOrder task=""insert""> <Number></Number> <CustomerNumber>99</CustomerNumber> <DeliveryNumber>100</DeliveryNumber> <DeliveryName>Toimitusasiakas</DeliveryName> page 7

10 <TermsOfPaymentId>1</TermsOfPaymentId> <OrderType>0</OrderType> <Rows> <Row> <Position>1</Position> <ArticleCode>akra</ArticleCode> <Amount>1</Amount> </Row> <Row> <Position>2</Position> <ArticleCode>mivv</ArticleCode> <Amount>2</Amount> </Row> <Row> <Position>3</Position> <ArticleCode>KOKO</ArticleCode> <Warehouse>2</Warehouse> <Amount>7</Amount> </Row> </Rows> </SalesOrder> </xml>" 'Note! I added servicereference to the project, which points to Nova Webservice. Dim client As ServiceReference1.NovaWebSDKSoapClient = New ServiceReference1.NovaWebSDKSoapClient Dim xmlresponse As XElement = New XElement("Empty") Dim xmlrequest As XElement = XElement.Parse(xmltext) Try xmlresponse = client.execute(xmlrequest.tostring) MsgBox(xmlResponse.ToString) Catch ex As Exception MsgBox(ex.Message) End Try You can find an example program in the Sample-folder. page 8

11 3.2 Test with Boomerang Underneath some examples of how to test web service with Boomerang (a plugin for Chrome) Execute or page 9

12 3.2.2 Execute2 Response NOTE! Remember to add prefix. Example on the next page. page 10

13 Example: <soap:envelope xmlns:soap=" xmlns:nov=" > <soap:header/> <soap:body> <nov:execute2> <nov:inputxml> <xml> <login> <hash dsn="nova">73685dbea b74a3a2e9c1c3ecc</hash> </login> <FetchArticlesLike> <ChangedAfter> </ChangedAfter> </FetchArticlesLike> </xml> </nov:inputxml> </nov:execute2> </soap:body> </soap:envelope> page 11