Rajapinnat
Kaikki verkkokauppasovellukset on mahdollista kytkeä suoraan Matkahuollon tietojärjestelmään XML-rajapinnan avulla.
XML-rajapinta on toteutettu yksinkertaisena XML-pyyntönä, johon vastaus tulee XML-muodossa. Pyyntö lähetetään (POST) https-protokollalla yhteysosoitteeseen. Onnistuneen pyynnön vastauksena tulee XML-tiedosto, joka sisältää vastauksen lisäksi osoitekortin pdf-dokumenttina. Pdf tulostetaan ja liitetään lähetykseen.
XML-pyynnön muoto on määrätty, mutta mukana on useita vapaaehtoisia kenttiä. Https-protokolla on ainoa sallittu, palvelin ei hyväksy suojaamatonta http-pyyntöä.
Matkahuollon noutopistehaku
Noutopistehaussa on mahdollista käyttää reaaliaikaisesti Matkahuollon tarjoamaa noutopistehaun API-rajapintaa tai päivittää Matkahuollon noutopistetiedot esimerkiksi kerran päivässä verkkokaupan tietokantaan, josta ne näytetään asiakkaille.
Matkahuollon noutopistehaku löytyy valmiina myös esimerkiksi nShiftin järjestelmistä.
Lataa noutopistehaun rajapintakuvaus
Seurantatiedot
Vastaanottaja voi seurata lähetyksen kulkua Matkahuollon verkkosivuilla olevan lähetysten seurannan kautta. Seurantatiedot voidaan näyttää myös verkkokaupan sivuilla Matkahuollon välittämien seurantatietojen perusteella.
Seurantatietojen tekninen kuvaus
Matkahuollon osoitekorttihaun rajapintakuvaus
Lähetystiedot välitetään Matkahuollolle sähköisesti API-kutsuna tai tiedostosiirtona. EDI-sanoma voi olla XML- tai CSV-muotoinen. Useimmat verkkokaupan tietojärjestelmät tukevat vaadittuja tiedostomuotoja ilman erilliskehitystä.
EDI-sanomassa välitetään mm. lähettäjän ja vastaanottajan tiedot. Vastaanottajan matkapuhelinnumero tai sähköpostiosoite ovat pakollisia tietoja mm. saapumisilmoituksen toimittamista varten.
Osoitekorttihaun rajapintakuvaus (API)
Osoitekorttihaun rajapintakuvaus (CSV)
Lataa malli pdf-osoitekortista
Esimerkkitiedostot
Käyttöönottoa helpottamaan Matkahuolto tarjoaa esimerkkikoodeja muutamalla yleisimmällä web-ohjelmointikielellä. Esimerkkikoodien käyttö on vapaata ja niitä saa käyttää sekä henkilökohtaisiin että kaupallisiin järjestelmiin. Koodeja voi käyttää sellaisenaan tai muokattuina, mutta omalla vastuulla. Huomioithan myös, että esimerkkikoodien toimintavarmuutta ei ole testattu kaikissa olosuhteissa.
Koodit ovat zip-pakattuja:
Php: matkahuolto_php.zip
Java: matkahuolto_java.zip
Ruby: matkahuolto_ruby.zip
Testaus ja käyttöönotto
Rajapinnan testausta varten Matkahuollon palvelimilla on testiympäristö, johon lähetetyt pyynnöt palauttavat oikeamuotoisen vastauksen. Testiympäristössä lähetystä ei oteta käsittelyyn. Käyttöönotto tapahtuu helposti yhteysosoitetta vaihtamalla.
Asiakastunnukset ja tekninen tuki
Testausta ja käyttöönottoa varten tarvitset maksuttoman asiakastunnuksen, jonka voit tilata Matkahuollosta sähköpostilla verkkokauppapalvelut@matkahuolto.fi.
Tekninen tuki auttaa käyttöliittymään ja xml-rajapintaan liittyvissä kysymyksissä. Sähköposti tekniseen tukeen on verkkokauppapalvelut@matkahuolto.fi.