Netvisorin rajapintaresurssien kuvaukset ovat siirtyneet uudelle OpenAPI-määrittelyyn perustuvalle dokumentaatioalustalle, jossa rajapintaresurssien tekninen rakenne on kuvattu selkeästi ja yhdenmukaisesti. Sieltä löytyvät jatkossa kaikkien resurssien parametrit, sanomarakenteet, elementit ja esimerkit, joita tällä sivulla ja sen alasivuilla on aiemmin kuvattu. Ohjeita ylläpidetään ja päivitetään jatkossa vain uudella alustalla.
• Netvisor API Guide – kirjalliset ohjeet rajapinnan käyttöön
• Netvisor API Reference – kaikkien resurssien tekninen kuvaus
Uuden alustan ohjeet ovat englanninkielisiä. Käyttötapausohjeissa elementtien rinnalla on kuitenkin myös Netvisorin käyttöliittymän suomenkieliset kenttien nimet, jotta rajapinnan elementit on helppo yhdistää käyttöliittymään.
Mitä uudelta alustalta löytyy
API Reference kuvaa jokaisen resurssin: HTTP-metodin, parametrit, pyyntö- ja vastaussanomien elementit, pakolliset tiedot, sallitut arvot, esimerkkisanomat ja virheilmoitukset.
Building a new integration – uuden integraation rakennus:
• Implementing a new integration: integraation toteutuksen vaiheet
• Authentication: autentikointi ja tunnisteet
• General: rajapinnan yleiset käytännöt, kuten vastaukset ja virheilmoitukset (Responses and errors) sekä liitteet (Attachments)
• MCP Server guidelines: suositukset kumppaneille, jotka rakentavat MCP-palvelimen (Model Context Protocol) Netvisorin rajapintojen päälle.
Best practises – suositellut toimintatavat yleisimpiin integraatioihin:
• myyntilaskujen integraatio (Sales Invoice Integration)
• ostolaskujen integraatio (Purchase Invoice Integration)
• HRM-integraatio (HRM Integration)
• työaikaintegraatio (working hours integration)
• ulkoisten maksutietojen tuonti Netvisoriin (Importing external payment data to Netvisor)
Netvisor API use cases – käyttötapausohjeet:
Ohjeet käyvät vaiheittain läpi, miten rajapintaa käytetään oikein. Esimerkiksi myyntilaskun tuonnissa kerrotaan, missä järjestyksessä asiakas ja tuotteet varmistetaan, mitkä tiedot ovat pakollisia ja mitä tuonnin jälkeen tapahtuu.
Resources – osiokohtaiset resurssiluettelot
(Sales, Purchases, Products, Travel, Accounting, Working time, Payroll & salaries, User management and user invitation, Document scan). Jokaisesta resurssista on linkki sen kuvaukseen API Referencessä. Luettelossa on myös linkit resurssien validointiskeemoihin (DTD- tai XSD-tiedostot), joiden avulla sanomat voi tarkistaa ennen lähettämistä.
Updates and news – ajankohtaiset muutokset:
• Netvisor releases: Netvisorin julkaisutiedotteet
• API change log: viikkokohtainen muutosloki rajapintaan tulleista uusista resursseista ja muutoksista