TEKNINEN MÄÄRITTELY. Matkahuollon osoitekorttihaun rajapinta. Ismo Koskinen

Transkriptio

1 TEKNINEN MÄÄRITTELY Matkahuollon osoitekorttihaun rajapinta Ismo Koskinen Versio 2.3 Päiväys Tekijä Ismo Koskinen

2 MUUTOSHISTORIA Versio ja pvm Laatija Muutoksen kuvaus 1.0 / Ismo Koskinen - Ensimmäinen versio 1.1 / Lasse Vuoti - Lisäyksiä 1.2 / Lasse Vuoti - puserid 1.3 / Ismo Koskinen - Lisätty SpecialHandling 2.0 / Ismo Koskinen - Aktivointikoodi, palautuskäsittely, muu maksaja 2.1 / Julian Iizuka - Päivitetty esimerkkejä versioon / Ismo Koskinen - Lisätty maakentät 2.3 / Ismo Koskinen - Lisätty mm. luovutushuomautukset ja erikoisluovutus

3 SISÄLTÖ YLEISTÄ 1 SANOMAKUVAUKSET Lähetyssanoma Vastaussanoma Virhesanoma 4 ESIMERKIT Lähetyssanoma Vastaussanoma Vastaussanoma (aktivoitava lähetys) Virhesanoma 7

4 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 1 (8) YLEISTÄ Tässä dokumentissa kuvataan Matkahuollon osoitekorttihaun rajapinta. Tämän rajapinnan avulla Matkahuollon pakettipalveluiden asiakkaat voivat välittää tiedot lähetyksistään sähköisesti Matkahuollon järjestelmään ja samalla saada vastaussanomassa pakettiin kiinnitettävien osoitekorttien tiedot PDF-muodossa. PDF dokumentti muodostetaan vastaussanoman XML:stä dekoodamalla ShipmentPdf elementin sisältö BASE64-DECODE funktiolla. Sanoman versiosta 2.0 alkaen yhdessä kyselyssä on mahdollista välittää usean lähetyksen tiedot. Vastaussanoman pdf sisältää kaikkien muodostettujen lähetysten osoitekortit yhdessä tiedostossa. Rajapinta perustuu XML-sanomiin, jotka siirretään asiakkaan ja Matkahuollon järjestelmien välillä. Tämä rajapinta ei käytä SOAP-kehyksiä, vaan pelkästään yksinkertaisia XML-sanomia. Palvelun käyttöönotto vaatii, että Matkahuollon myyjä ilmoittaa asiakkaan asiakasnumeron ITosastolle, joka avaa palvelun kyseiselle asiakasnumerolle. Tuotantosanomat lähetetään osoitteeseen Testausta varten on osoite HTTP-pyynnössä täytyy asettaa Content-Type attribuutin arvoksi application/xml. Mikäli näin ei ole, palvelin palauttaa virhestatuksen. Palvelu on SSL varmennettu, pyynnöt on mahdollista tehdä vain https: protokollan yli. SANOMAKUVAUKSET 2.1 Lähetyssanoma XML-elementti P Kuvaus Huomautukset Versio MHShipmentRequest X Sanoman tunnus UserId X Asiakkaan MHasiakasnumero MH ilmoittaa asiakkaalle Password X Asiakkaan salasana MH ilmoittaa asiakkaalle Version X Sanomakuvauksen versionumero Shipment X Aloittaa uuden lähetystiedon ShipmentType X Lähetyksen tyyppi N=normaali lähetys 2.0 (oletus) A=aktivoitava lähetys R=palautuslähetys MessageType X Sanoman tyyppi N=uusi C=muutos D=poisto/peruutus ShipmentNumber Lähetyksen numero Jos tyhjä, haetaan MH:n sarjasta ShipmentDate Lähetyspäivä PP.KK.VVVV Weight Lähetyksen kokonaispaino Esim. 1.23,

5 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 2 (8) desimaalierotin piste Volume Lähetyksen kokonaistilavuus Esim , desimaalierotin piste Packages X Lähetyksen pakettimäärä Kokonaisluku SenderId X Lähettäjän asiakasnumero max. 8 numeroa, esim SenderName1 Lähettäjän nimi 1 SenderName2 Lähettäjän nimi 2 SenderAddress Lähettäjän katuosoite SenderPostal Lähettäjän postinumero SenderCity Lähettäjän paikkakunta SenderCountry Lähettäjän maa Kaksimerkkinen 2.0 maatunnus (FI = Suomi) SenderContactName Lähettäjän yhteyshenkilö SenderContactNumber Lähettäjän yhteysnumero Sender Lähettäjän sähköpostiosoite SenderReference Lähettäjän viite DeparturePlaceCode Lähtöpaikan/-aseman tunnus DeparturePlaceName Lähtöpaikan/-aseman nimi ReceiverId Vastaanottajan asiakasnumero ReceiverName1 X Vastaanottajan nimi 1 ReceiverName2 Vastaanottajan nimi 2 ReceiverAddress Vastaanottajan katuosoite ReceiverPostal X Vastaanottajan postinumero ReceiverCity X Vastaanottajan paikkakunta ReceiverCountry Vastaanottajan maa Kaksimerkkinen 2.0 maatunnus (FI = Suomi) ReceiverContactName Vastaanottajan yhteyshenkilö ReceiverContactNumber Vastaanottajan yhteysnumero Receiver Vastaanottajan sähköpostiosoite ReceiverReference Vastaanottajan viite ReceiverLanguage Vastaanottajan kielitunnus FI=suomi, SV=ruotsi, 2.3 EN=englanti DestinationPlaceCode Määräpaikan/-aseman tunnus DestinationPlaceName Määräpaikan/-aseman nimi PayerCode Rahdin maksajan koodi S=lähettäjä (oletus) 2.0 R=vastaanottaja O=muu (koodi ilmoitettava PayerIdkentässä) PayerId Maksajan asiakasnumero Pakollinen, jos 2.0 maksajakoodi O=muu PayerName1 Maksajan nimi PayerName2 Maksajan nimi PayerAddress Maksajan katuosoite 2.0 PayerPostal Maksajan postinumero 2.0 PayerCity Maksajan paikkakunta 2.0 PayerCountry Maksajan maa Kaksimerkkinen 2.0 maatunnus (FI = Suomi) PayerContactName Maksajan yhteyshenkilö 2.0 PayerContactNumber Maksajan yhteysnumero 2.0 Payer Maksajan sähköpostiosoite 2.0 PayerReference Maksajan viite 2.0 Remarks Huomautukset ProductCode X Matkahuollon tuotekoodi ks. lista alla ProductName Matkahuollon tuotteen nimi

6 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 3 (8) Pickup Noudettava lähetys Y=yes, N=no, oletus N PickupPayer Noudon maksaja S=lähettäjä, R=vast.ottaja, oletus S PickupRemarks Noutohuomautus Delivery Jaettava lähetys Y=yes, N=no, oletus N DeliveryPayer Jaon maksaja S=lähettäjä, R=vast.ottaja, oletus S DeliveryRemarks Jakohuomautus CODSum Bussiennakon summa 2 desimaalia, desimaalierotin piste CODCurrency Bussiennakon valuutta Oletus EUR CODAccount Bussiennakon pankkitili (IBAN) CODBic Bussiennakon pankkitunnus 2.0 (BIC) CODReference Bussiennakon pankkiviite Goods Lähetyksen sisältö SpecialHandling Erikoiskäsittelymerkintä Erikoiskäsittelyn koodi, ks. lista alla VAKCode Vaarallisen aineen koodi VAK-luokka VAKDescription Vaarallisen aineen kuvaus DocumentType Palautettavan kuljetusdokum. tyyppi Arvolla NO ei palauteta kuljetusdokumenttia. SpecialHandover Erikoisluovutus, esim. Y=yes, N=no, oletus N 2.3 turvaluovutus tms. HandoverRemark1 Luovutushuomautus1 2.3 HandoverRemark2 Luovutushuomautus2 2.3 HandoverRemark3 Luovutushuomautus3 2.3 ShipmentRow Aloittaa pakettirivitason Max 15 pakettia per lähetys PackageId Paketin tunnus Weight Paketin paino Volume Paketin tilavuus Goods Paketin sisältö Pakolliset tiedot on merkitty sarakkeessa P. Huomioitava, että maksavan osapuolen tunnus (asiakasnumero) on aina pakollinen (senderid, receiverid tai payerid). Jos sanoman toimittava asiakas tuottaa itse lähetystunnuksen omasta sarjastaan, ShipmentRow-tiedot tulee lisästä jokaiselle lähetyksen pakettitunnukselle. Esimerkki: Lähetystunnuksen ollessa MA ja lähetys sisältää kollit MA ja MA , niin: <ShipmentRow> <PackageId>MA </PackageId> </ShipmentRow> <ShipmentRow> <PackageId>MA </PackageId> </ShipmentRow> Tuotetietokentissä käytettävät arvot ovat seuraavat; ProductCode ProductName 10 Bussipaketti 30 Jakopaketti

7 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 4 (8) 34 Kotijakelu 40 Rahtipussi 42 Rahtipussin jakopaketti 43 Dokumenttikuori 44 Dokumenttikuoren jakopaketti 57 Lavarahti 70 Ulkomaan lentoasiakirja 71 Ulkomaan lentopaketti 72 Ulkomaan paketti 80 Lähellä-paketti 95 Ulkomaan verkkopaketti 96 Ulkomaan jakopaketti Erikoiskäsittelykoodit SpecialHandling E01 K02 K03 K04 K05 Kuvaus Vaarallinen aine (VAK-luokka kenttään VAKCode) Ympärysmitta Tankomainen Varoen käsiteltävä Lämpösäädelty kuljetus 2.2 Vastaussanoma XML-elementti Kuvaus Huomautukset Versio MHShipmentReply Sanoman tunnus Version Sanomakuvauksen versionumero Shipment Aloittaa lähetystason ShipmentNumber Lähetyksen numero SenderReference Lähettäjän viite ActivationCode Aktivointikoodi 2.0 ShipmentPdf Varsinainen kuljetusdokumentti Binääri-pdf, siirretty Shipment-tason ulkopuolelle versiosta 2.0 alkaen pdfname Dokumentin originaali nimi ja tiedostopääte xxxxx.pdf, siirretty Shipment-tason ulkopuolelle versiosta 2.0 alkaen Vastaussanomassa siis palautuu varsinaisen kuljetusdokumentin lisäksi erillisissä kentissä lähetyksen tunniste sekä lähettäjän ilmoittama viitetieto. Näiden perusteella asiakkaan on mahdollista tallettaa omaan järjestelmäänsä saatu lähetysnumero mm. pakettiseurantaa varten. Mikäli kyseessä oli aktivoitava lähetys, niin lähetysnumeron lisäksi palautetaan myös aktivointikoodi. Mikäli kyseessä on lähetyksen poistosanoma (MessageType = D) ja lähetyksen poisto onnistuu, vastaus muodostuu virhesanomasta, jossa ErrorNbr on Virhesanoma

8 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 5 (8) XML-elementti Kuvaus Huomautukset Versio MHShipmentReply Sanoman tunnus Version Sanomakuvauksen versionumero ErrorNbr Virhenumero ErrorMsg Virheen kuvaus Shipment Aloittaa lähetystason ShipmentNumber Lähetyksen numero 2.3 SenderReference Lähettäjän viite 2.3 ErrorNbr Virhenumero 2.3 ErrorMsg Virheen kuvaus 2.3 Virhesanoman ShipmentNumber ja SenderReference -kentät viittaavat lähetystietoon, jossa virhe havaittiin (mikäli virhe kohdistuu tiettyyn lähetykseen). Virhenumerot ja niiden kuvaukset voivat olla esim. seuraavia; 0 Lähetys poistettu 1001 Ei käyttöoikeutta 1002 Virheellinen lähettäjän asiakasnumero 1003 Pakollinen tieto puuttuu 1004 Muu virhe sanomassa 1005 Muu järjestelmävirhe 1006 Tuotteelle sallittu maksimipaino ylittyy 1007 Tuotteelle sallittu maksimipakettimäärä ylittyy 1008 Virheellinen lähetysnumero 1009 Virheellinen pakettinumero 1010 Virheellinen lähetystyyppi 1011 Virheellinen sanomatyyppi 1012 Virheellinen tuotelaji 1013 Virheellinen määräpaikka 1014 Sallittu maksimitilavuus ylittyy 1015 Bussiennakkosumma ylittää tuotteelle asetetun maksimiarvon

9 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 6 (8) ESIMERKIT 3.1 Lähetyssanoma <?xml version='1.0' encoding='utf-8'?> <MHShipmentRequest> <UserId> </UserId> <Password>456</Password> <Version>2.0</Version> <Shipment> <ShipmentType>N</ShipmentType> <MessageType>N</MessageType> <ShipmentNumber></ShipmentNumber> <ShipmentDate> </ShipmentDate> <Weight>3.25</Weight> <Volume>0.025</Volume> <Packages>2</Packages> <SenderId> </SenderId> <SenderName1>TESTIASIAKAS OY</SenderName1> <SenderName2></SenderName2> <SenderAddress>Kaivokatu 1</SenderAddress> <SenderPostal>00100</SenderPostal> <SenderCity>HELSINKI</SenderCity> <SenderCountry>FI</SenderCountry> <SenderContactName>Liisa Lähettäjä</SenderContactName> <SenderContactNumber> </SenderContactNumber> <Sender >liisa.lahettaja@testiasiakas.fi</Sender > <SenderReference>L </SenderReference> <DeparturePlaceCode></DeparturePlaceCode> <DeparturePlaceName>HELSINKI</DeparturePlaceName> <ReceiverId></ReceiverId> <ReceiverName1>MALLIASIAKAS OY</ReceiverName1> <ReceiverName2></ReceiverName2> <ReceiverAddress>HÄMEENKATU 1</ReceiverAddress> <ReceiverPostal>33100</ReceiverPostal> <ReceiverCity>TAMPERE</ReceiverCity> <ReceiverCountry>FI</ReceiverCountry> <ReceiverContactName>Ville Varastomies</ReceiverContactName> <ReceiverContactNumber> </ReceiverContactNumber> <Receiver >info@malliasiakas.fi</Receiver > <ReceiverReference>V112233</ReceiverReference> <ReceiverLanguage>FI</ReceiverLanguage> <DestinationPlaceCode></DestinationPlaceCode> <DestinationPlaceName>TAMPERE</DestinationPlaceName> <PayerCode>O</PayerCode> <PayerId> </PayerId> <PayerName1>MAKSAJA OY</PayerName1> <PayerName2></PayerName2> <PayerAddress>Asematie 1</PayerAddress> <PayerPostal>01300</PayerPostal> <PayerCity>VANTAA</PayerCity> <PayerCountry>FI</PayerCountry> <PayerContactName>Matti Maksaja</PayerContactName> <PayerContactNumber> </PayerContactNumber> <Payer >liisa.lahettaja@testiasiakas.fi</Payer > <PayerReference>M2233</PayerReference> <Remarks></Remarks> <ProductCode>30</ProductCode> <ProductName>JAKOPAKETTI</ProductName> <Pickup>Y</Pickup>

10 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 7 (8) <PickupPayer>S</PickupPayer> <PickupRemarks>NOUDETTAVA ENNEN KLO 16</PickupRemarks> <Delivery>Y</Delivery> <DeliveryPayer>R</DeliveryPayer> <DeliveryRemarks>SOITTO ENNEN JAKELUA</DeliveryRemarks> <CODSum>105.55</CODSum> <CODCurrency>EUR</CODCurrency> <CODAccount>FI </CODAccount> <CODBic>NDEAFIHH</CODBic> <CODReference>13</CODReference> <Goods>Varaosia</Goods> <SpecialHandling>K04</SpecialHandling> <VAKCode></VAKCode> <VAKDescription></VAKDescription> <DocumentType></DocumentType> <SpecialHandover>Y</SpecialHandover> <HandoverRemark1>Luovutus vain yli 18-vuotiaille</HandoverRemark1> <HandoverRemark2>Valtakirja vaaditaan</handoverremark2> <HandoverRemark3>Kolmas huomautus</handoverremark3> </Shipment> </MHShipmentRequest> 3.2 Vastaussanoma <?xml version='1.0' encoding='iso '?> <MHShipmentReply> <Version>2.0</Version> <Shipment> <ShipmentNumber>MH FI</ShipmentNumber> <SenderReference>L </SenderReference> </Shipment> <ShipmentPdf>...Kuljetusdokumenttti pdf-muodossa...base64-encoded </ShipmentPdf> <PdfName> MH FI.pdf </PdfName> </MHShipmentReply> 3.3 Vastaussanoma (aktivoitava lähetys) <?xml version='1.0' encoding='iso '?> <MHShipmentReply> <Version>2.0</Version> <Shipment> <ShipmentNumber>MH FI</ShipmentNumber> <SenderReference>L </SenderReference> <ActivationCode> </ActivationCode> </Shipment> <ShipmentPdf>...Kuljetusdokumenttti pdf-muodossa...base64-encoded </ShipmentPdf> <PdfName> MH FI.pdf </PdfName> </MHShipmentReply> 3.4 Virhesanoma

11 OSOITEKORTTIHAUN RAJAPINTAKUVAUS 8 (8) <?xml version='1.0' encoding='iso '?> <MHShipmentReply> <Version>2.0</Version> <ErrorNbr>1001></ErrorNbr> <ErrorMsg>Ei käyttöoikeutta</errormsg> </MHShipmentReply> <?xml version='1.0' encoding='iso '?> <MHShipmentReply> <Version>2.0</Version> <ErrorNbr>1002></ErrorNbr> <ErrorMsg>Virheellinen lähettäjän asiakasnumero</errormsg> <Shipment> <ShipmentNumber>MA </ShipmentNumber> <SenderReference>SR1</SenderReference> <ErrorNbr>1002></ErrorNbr> <ErrorMsg>Virheellinen lähettäjän asiakasnumero</errormsg> </Shipment> </MHShipmentReply>