Visma Nova Webservice
Tämä ohjeistus sisältää Visma Nova Webservicen asennusohjeen ja käyttöohjeen.
XML -sanomakuvaukset löytyvät osiosta Visma Nova Webservice XML kuvaukset
Tukisähköposti: [email protected]
Nova WebService ja Nova ympäristön kuvaus
Nova webservice asennetaan Nova asiakkaan ympäristöön Windows palvelimelle, jossa on IIS (Internet Information Services) palvelut asennettuna ja tältä palvelimelta tulee olla yhteys Novan tietokantapalvelimelle (SQL server). Webservicen asennuksen aikana muodostetaan yksilöllinen avain, jonka avulla 3. osapuoli ottaa yhteyden haluttuun asiakkaan Novan yritystietokantaan. Asiakas myöskin kertoo 3. Osapuolelle, mistä osoitteesta webservice vastaa
(esimerkiksi: https://asiakkaandomain.fi/NovaWebService/NovaWebSDK.asmx?).
Webservicen käytetään välittämällä xml sanoma execute metodin avulla ja webservice palauttaa paluuviestin xml muodossa.
Osapuolen tehtäväksi jää sovelluksen toteuttaminen, joka sitten käyttää Visma Nova webservice rajapintaa.
HUOM! Asiakas on vastuussa IIS asetuksista.
Yleistä integraatio projektista
Kaikki ohjelmien integraatioprojektit lähtevät liikkeelle määrittelystä, jossa integraation toteutuksen tilaaja ja integraation toteuttaja yhdessä määrittelevät toteutettavan integraation sisällön toiminnallisuuksineen sekä rajauksineen ja varmistuvat siitä, että tarjolla olevat rajapinnat integraation toteutukseen mahdollistavat halutunlaisen integraation toteutuksen. Määrittely kannattaa aina tehdä kirjallisesti.
Integraation toteutusvaiheen testausta varten on hyvä olla mahdollisimman hyvin tuotantoympäristöä vastaava testiympäristö, jolloin pystytään jo toteutusvaiheessa testaamaan mahdollisimman hyvin erilaiset käyttötapavariaatiot. Tuotantoympäristössä integraatio otetaan käyttöön vasta, kun kaikki erilaiset määritetyt käyttötapavariaatiot on testattu ja todettu toimivaksi suunnitellusti tuotantoympäristöä vastaavassa testiympäristössä.
Määrittelyvaiheeseen osallistumisesta voidaan tarvittaessa pyytää tarjous myös Visma Amplio Oy:ltä oman vastuumyyjän kautta.
Yleiset vaatimukset
Windows palvelin: Windows Server 2019 tai uudempi
Net 4.5 full
IIS asennettuna palvelimelle
Palvelimella julkinen IP
Palomuuri avaukset sovittava integraattorin ja asiakkaan välillä. Webservice käyttää porttia 80 (http) tai 443 (https). Suosittelemme käyttämään HTTPS protokollaa
Admin tasoinen asennustunnus
Toimenpiteet ennen asennusta
Novasta pitää olla asennettu viimeisin versio.
IIS pitää olla valmiiksi asennettuna ympäristössä ennen webservicen asennusta.
IIS:ssä pitää olla oletusten lisäksi valittuna myös
Application Development
.Net Extensibility 3.5
.Net Extensibility 4.5:
ASP.NET 3.5
HTTP Activation
ASP.NET 4.5
WCF Services
HTTP Activation
Management Tools
IIS Management Scripts and Tools
ISAPI and CGI restrictions: pitää olla sallittu asp.net 4.0 versiolle
.NET Globalization asetuksissa tulee olla valittuna Invariant Language.
HUOM! Huolehdi, että sinulla on riittävät oikeudet asennuksen suorittamiseen, koska suurin osa asennuksen aikana tapahtuvista virheistä johtuu yleensä puutteellisista käyttäjäoikeuksista.
Nova WS rajapinnan käyttäminen
Visma Nova Webservice on SOAP-mallin mukainen ja sisältää seuraavat webmetodit:
Execute
Pääasiallinen metodi, jonka avulla XML sanomat lähetetään webservicelle. Palauttaa XML sanoman. Tämä ottaa sisään string.
Execute2
Muuten sama kuin Execute metodi. Ero on siinä, että se ottaa sisään XML:n
ExecuteEx
Ei käytössä
HelloWorld
Testi metodi
SDKVersion
Palauttaa Webservicen käytttämän NovaSDK:n versionumeron
WebServiceVersion
Palauttaa Webservicen versionumeron
Execute -metodin avulla lähetetään webservicelle XML sanoma, joka koostuu kahdesta osasta: Login osa ja metodi osa. Logon osassa kerrotaan aina mitä yhteyttä halutaan käyttää. Login osiossa vaadittavat avaimen saat Webservicen asennuksen tehneeltä osapuolelta. Esimerkissä
tagien sisällä
elementti kertoo avaimen, jota käyttää.
73685dbea3290215b74a3a2e9c1c3ecc
tuote1
Varsinainen toiminto jota halutaan execute -metodin avulla tehdä on edellä mainitussa esimerkissä:
tuote1
Execute metodi palauttaa paluuviestinä xml sanoman.
Esimerkkejä näistä toiminnoista sekä niiden kuvaukset löytyvät erillisestä dokumentista.
Tässä esimerkki vb.NET kielellä, jossa muodostetaan tilaus Novan webservicen avulla:
Dim xmltext As String = "
73685dbea3290215b74a3a2e9c1c3ecc
99
100
Toimitusasiakas
1
0
1
akra
1
2
mivv
2
3
KOKO
2
7
"
'Huom! Olen lisännyt projektille serviceReferensen, joka viittaa Novan Webserviceen.
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
Lisäksi asennuspaketista löytyy Sample -kansiosta esimerkki ohjelma.
Testi Boomerang:lla
Alla pari esimerkkiä miten webservistä voi testata Bomerangilla (plugin Chromeen)
Execute
tai
Execute2
Response
HUOM! Muista prefixit.
Esimerkki
73685dbea3290215b74a3a2e9c1c3ecc
01-06-2018












