Integraation rakentaminen Maventaan
Tämä artikkeli opastaa ohjelmistotoimittajia integraation rakentamisen läpi. Siinä kerrotaan, mitä kannattaa päättää ennen aloittamista, miten valitaan kolmesta integraatiotasosta ja miksi REST API on oikea valinta uusiin integraatioihin. Artikkeli käy läpi jokaisen vaiheen myyntiin yhteydenotosta tuotantoon siirtymiseen sekä integraation käyttämät kolme tunnistetta. Lisäksi kerrotaan, mitä testiympäristöltä voi odottaa, mitä Maventa tarkistaa ennen tuotantoa ja mitä tapahtuu käyttöönoton jälkeen. Lopussa olevasta taulukosta näet, keneen ottaa yhteyttä missäkin asiassa.
Voit rakentaa integraation Maventaan REST API:n kautta. Maventan integraatiotiimi tukee sinua ensimmäisestä testikutsusta siihen asti, kun integraatiosi on tuotannossa.
Ennen kuin aloitat
Mieti, mitä integraatiosi pitää tehdä. Kun vastaat näihin kysymyksiin etukäteen, ensimmäisestä keskustelusta Maventan kanssa on enemmän hyötyä:
- Lähettäminen, vastaanottaminen vai molemmat? Lähettääkö ohjelmistosi laskuja, vastaanottaako se niitä vai molempia?
- Keitä vastaanottajat ovat? Muita yrityksiä (B2B), julkista sektoria (B2G) vai kuluttajia (B2C)? Kuluttajalaskutus toimii jokaisessa maassa eri tavalla.
- Mitkä maat? Saatavilla olevat palvelut vaihtelevat maittain. Katso Services and reach.
- Mitkä lisäpalvelut? Esimerkiksi tulostuspalvelu, paperilaskujen skannaus, Detectin petostarkistukset tai saatavienhallinnan palvelut.
Valitse, kuinka laajasti integroit
Kaikkea ei tarvitse rakentaa kerralla. Integraatio-ohjeessa kuvataan kolme integraatiotasoa:
- Taso 1, pieni työmäärä: Laskut lähetetään ja vastaanotetaan API:n kautta. Käyttäjät hallitsevat yrityksen asetuksia ja seuraavat laskuja Maventan käyttöliittymässä, ja virheet käsitellään sähköposti-ilmoitusten avulla.
- Taso 2, keskisuuri työmäärä: Kuten taso 1, mutta myös virheet käsitellään Maventan käyttöliittymässä sähköpostin sijaan.
- Taso 3, suuri työmäärä: Kaikki tapahtuu API:n kautta, myös asetukset, seuranta ja virheiden käsittely. Käyttäjien ei tarvitse koskaan poistua ohjelmistostasi.
Moni integraatio aloitetaan kevyemmällä tasolla ja sitä laajennetaan myöhemmin. Jos haluat tarjota Maventan ominaisuuksia tuotteessasi rakentamatta niitä itse, vaihtoehtona on myös upotettava käyttöliittymä.
Käytä REST API:a
Maventalla on kaksi rajapintaa: REST ja SOAP. Käytä uusissa integraatioissa REST API:a. SOAP API on vanha rajapinta, eikä se tue kaikkia ominaisuuksia. Uudet ominaisuudet lisätään REST API:in. Lue lisää.
Integraation vaiheet
- Keskustele myynnin kanssa. Myynti käy kanssasi läpi, mitä haluat tarjota asiakkaillesi, ja ohjaa sinut integraatiotiimille. Tarpeidesi mukaan Maventa voi järjestää myös aloituspalaverin tai koulutuksen. Ota yhteyttä Inexchangen myyntiin.
- Hanki pääsy testiympäristöön. Integraatiotiimi luo sinulle kumppanitilin testiympäristöön ja antaa tarvitsemasi tunnisteet.
- Rakenna ja testaa. Rakenna integraatiosi testiympäristöä vasten. Integraatiotiimi vastaa teknisiin kysymyksiin matkan varrella.
- Validointi. Ennen tuotantoa Maventa tarkistaa, että integraatiosi toimii oikein.
- Allekirjoita sopimus. Kaikki integraattorit allekirjoittavat Maventan integraatiosopimuksen (Maventa Integration Agreement). Se kattaa laskutuksen, vastuut ja tuen, ja saat sen integraatioyhteyshenkilöltäsi.
- Siirry tuotantoon. Saat tuotantoympäristön tunnisteet ja voit ottaa tuotantoympäristön käyttöön.
Tunnisteesi
Integraatiosi käyttää kolmea tunnistetta yhteyden muodostamiseen Maventaan:
- Company UUID: yksilöi yritystilin
- User API key: yksilöi yrityksen käyttäjän
- Vendor API key: yksilöi ohjelmistosi
⚠️ Tietoturvan vuoksi on erittäin tärkeää, ettei käyttäjän tai ohjelmistotoimittajan API-avainta koskaan jaeta kokonaisuudessaan ulkopuolisille. API-avaimen jakaminen kolmansille osapuolille on merkittävä tietoturvariski.
Vendor API key yhdistää API-kutsut sinun yritykseesi kumppanina. Maventa käyttää sitä laskutukseen ja raportointiin. Yhdellä kumppanilla voi olla useita vendor API keyta, esimerkiksi yksi kutakin tuotetta tai maata kohden.
Testi- ja tuotantoympäristöllä on omat tunnisteensa. Toisen ympäristön avaimet eivät toimi toisessa. Lue lisää.
Työskentely testiympäristössä
Testiympäristössä voit kokeilla useimpia toimintoja ennen tuotantoon siirtymistä. Muista nämä:
- Osa toimituksista on oikeita, osa simuloituja. Peppol-testilähetykset ja lähetykset Maventa-tilien välillä toimivat kuten tuotannossa. Sähköposti-, tulostus- ja kuluttajareitit sekä ulkoisten operaattoreiden reitit Suomessa ja Ruotsissa ovat simuloituja: lasku merkitään lähetetyksi, mutta sitä ei oikeasti toimiteta.
- Ilmoitussähköpostit ovat oikeita. Käytä sähköpostiosoitteita, joihin sinulla on pääsy. Älä käytä keksittyjä osoitteita tai asiakkaidesi oikeita osoitteita.
- Älä käytä oikeita tietoja. Testiympäristöä käytetään myös Maventan omaan testaukseen. Se voi olla ajoittain pois käytöstä, ja sen tiedot voidaan tyhjentää ilman ennakkoilmoitusta.
Mitä Maventa tarkistaa ennen tuotantoa
Ennen kuin integraatiosi otetaan tuotantokäyttöön, Maventa varmistaa, että se toimii odotetusti. Esimerkiksi:
- laskut menevät oikeille vastaanottajille oikeilla tiedoilla
- lähettäminen Peppol-verkostoon toimii niissä maissa, joissa sitä käytetään
- kuluttajalaskutus on määritetty oikein, jos sitä käytetään
- vastaanotetut laskut haetaan oikeassa muodossa
- webhookit (Maventan automaattiset ilmoitukset järjestelmääsi) vastaanotetaan ja käsitellään
- ohjelmistosi ei tarkista päivityksiä tarpeettoman usein
Tuotantoon siirtymisen jälkeen
- Asiakkaasi vahvistavat tilinsä. Ennen kuin asiakkaan yritystiliä voi käyttää täysimääräisesti, yritystä edustamaan oikeutetun henkilön täytyy vahvistaa se. Vahvistustapa riippuu maasta. Lue lisää.
- Asiakkaiden jälleenlaskutus. Maventan sinulle lähettämän laskun liitteenä on tapahtumaraportti, jossa näkyvät kunkin asiakkaan tapahtumat. Useimmat kumppanit käyttävät sitä asiakkaidensa laskuttamiseen. Lue lisää.
- Pysy ajan tasalla muutoksista. Seuraa kehittäjien muutoslokia (Developer Changelog) ja tiedotteita.
- Varaudu palvelukatkoihin. Ohjelmistosi pitäisi näyttää selkeä viesti, kuten ”Palvelu ei ole juuri nyt käytettävissä, yritä myöhemmin uudelleen”, eikä jumittua tai näyttää käyttäjille raakoja virheilmoituksia.
Keneen ottaa yhteyttä
| Tarvitset apua | Ota yhteyttä |
|---|---|
| Uusi integraatio, hinnoittelu tai sopimukset | Inexchangen myynti |
| Testitilit, API-avaimet, integraation validointi | Integraatiotiimi: integrations@maventa.com |
| Ongelma tuotannossa | Maventan tuki |