Kirjaudu sisään
nShift Help Center

Aloittaminen Shipment Server -integraation kanssa

Avatar
Malene Tidemann
Päivitetty

Aloittaaksesi Shipment Serverin käytön tarvitset Shipment Server -tilauksen ja käyttäjätilin. Voit käyttää Developer Tools -työkaluja testaukseen ja oppiaksesi, miten pyyntöjä muodostetaan. Tämä artikkeli kattaa perusasiat, jotka tarvitset integraation aloittamiseen:

Pääsy Shipment Server API:in

Yhteys Shipment Server API:in tapahtuu HTTPS:n kautta portissa 443.

Jokaisella Shipment Serveriä käyttävällä asiakkaalla tulee olla vähintään token ja actor_id.
Token ja actor_id on sisällytettävä kaikkien pyyntöjen payload/body-osaan.

Web-palvelinta käytetään RESTin kautta ja kaikissa metodeissa käytetään POSTia. 

 

Request body ottaa vastaan multipart/form-data- tai application/x-www-form-urlencoded -objektin, jossa on seuraavat avaimet:
actor, key, command, data, options

  • actor - toimijan tunnus
  • key - toimijan käyttöoikeustoken 
  • command - API:ssa suoritettava metodi 
  • options - joitakin komentoja voidaan ohjata lisäasetuksilla
  • data - komennon payload (esimerkiksi lähetysobjekti)
     

Tietotyypit:

  • Numeric - numeeriset kentät, joiden arvo on 0 (nolla), eivät sisälly web-palvelun tuottamaan JSON-merkkijonoon, koska arvo 0 (nolla) on oletusarvo.
     
  • String - tyhjät merkkijonot eivät sisälly web-palvelun tuottamaan JSON-merkkijonoon.
     
  • DateTime - päivämäärät ja aikaleimat muotoillaan ISO 8601 -standardin mukaisesti. Esimerkki päivämäärästä on 2019-06-27 ja aikaleimasta: 2019-06-27T10:25:00.
    Tärkeää: Huomaa, että tuemme vain laajennettuja esitystapoja emmekä perusmuotoja ilman väliviivoja, joten esimerkiksi 20190627 ei ole hyväksytty. Aikavyöhykkeet poistetaan pyynnöstä ja millisekunnit ohitetaan. 
     
  • Enum - jotkin kentät lähetetään enum-arvoina, mikä tarkoittaa, että ne lähetetään kokonaislukuarvona, mutta arvolla on tietty merkitys. Katso liite Objects and Fields saadaksesi täydellisen listan näiden kenttien mahdollisista arvoista.

 

Developer Tools

Developer Tools -työkalut mahdollistavat pyyntöjen testaamisen ja rakentamisen Shipment Server API:in. Developer Tools on integroitu Portalin New Bookings -käyttöliittymään, ja se näyttää sekä palvelimelle lähetettävän JSON-pyynnön että palvelimen JSON-vastauksen, joita voidaan käyttää tarkastelemaan, miten pyyntö on rakennettu.

 

Developer Tools -työkalujen aktivointi

  1. Kirjaudu sisään nShift Portaliin.
     
  2. Siirry kohtaan Ship > Configuration >Settings ylävalikossa.

    settings-tab.png
     
  3. Vieritä alas ja valitse Show developer tools otsikon Production alta.

    developer-tools.png
     
  4. Sinulla on nyt pääsy Developer Tools -työkaluihin kaikkien asiaankuuluvien sivujen alareunassa kohdassa New Bookings.

 

Developer Tools -työkalujen käyttö

Developer Tools -osiossa on kaksi pudotusvalikkoa, joissa voit asettaa label type ja command. Huomaa, että käytettävissä olevat komennot vaihtelevat sen mukaan, millä sivulla olet. Jos pyyntöön tarvitaan lähetystietoja, Developer Tools käyttää nykyiselle sivulle syöttämiäsi tietoja. Näin voit helposti täyttää tarvittavat tiedot ja nähdä, miltä pyyntö näyttää.

developer-tools-section.png

Kenttä Data näyttää pyynnön. Joissakin komennoissa on lisäasetuksia, jotka lisätään Options-kenttään.

Katso metodilista täältä nähdäksesi, mitkä asetukset ovat käytettävissä kullekin komennolle. Kenttä Response näyttää vastauksen, jonka saat pyynnön lähettämisen jälkeen.

 

 

Esimerkki SubmitShipment-pyynnön luomisesta

SubmitShipment-komento luo lähetyksen ja palauttaa vastauksena etiketin.

  1. Siirry kohtaan Ship > New ja täytä kaikki lähetykseen liittyvät kentät, kuten osoitetiedot, kuljetusliike ja tavaratiedot.
     
  2. Valitse Developer Tools -osiossa komento SubmitShipment. Tämä näyttää pyynnön Data-kentässä käyttämällä syöttämiäsi lähetystietoja. Voit täyttää tietoja viitekenttiin, viesteihin jne. ja nähdä heti, miten ne lisätään pyyntöön.
     
  3. Napsauta Send-painiketta. Jos pyyntö onnistuu, saat vastauksen, joka sisältää etiketin. Jos pyynnöstä puuttuu jotain, saat virheilmoituksen vastauksessa. 
     
  4. Napsauta View labels -painiketta nähdäksesi onnistuneen SubmitShipment-pyynnön etiketit. 
     
  5. Käytä Reformat data, jos olet muokannut tietoja tai liittänyt pyynnön data-kenttään ja haluat nähdä tiedot helpommin luettavassa muodossa.

 

Vinkki: Jos rakennat pyyntöjä Shipment Serverille, voit kopioida ja liittää pyyntösi Data-kenttään ja testata niitä. Jos pyyntösi sisältää jo kaikki tarvittavat tiedot, sinun ei tarvitse täyttää sivun kenttiä. Käyttöliittymä tarjoaa vain helpon tavan nähdä, miten tiedot lisätään pyyntöön.

 

Katso kaikki Commands ja Options täältä.

 

Etikettien tulostaminen

Shipment Server ei käsittele etikettien tulostamista millään tavalla asiakaspuolella. Sinun tulee toteuttaa ympäristöösi sopiva ratkaisu.

 

Jos tulostat verkkoselaimesta, ActiveX controlin ja/tai JavaScriptin käyttö voi olla ratkaisu. 

 

Windows-sovelluksesta tulostamiseen voit käyttää Zebra-etikettitulostimien omaa kieltä EPL tai ZPL. Tässä tapauksessa tarvitset Zebra-tulostimen tai sitä tukevan tulostimen. Kun EPL / ZPL -etikettityyppi tallennetaan tiedostoon tai käytetään streamista, voit lähettää sen tulostimelle käyttämällä “move”- tai “copy”-toimintoa jaettua tulostinta varten. PNG- ja PDF-tulostus Windowsissa voidaan tehdä tulostusvalintaikkunan kautta tai automatisoida Win32API:n avulla tai käyttämällä unmanaged-koodia winspool.drv:n ja Marshallingin kanssa.


Voit myös käyttää nShiftin Drop Zone -sovellusta ja Cloud Print -ratkaisua. Cloud Print on pilvipohjainen ratkaisu, jonka avulla voit tulostaa monin eri tavoin. Dokumentit tallennetaan pilvessä olevaan jonoon, ja Drop Zone -asennukset lataavat niille kuuluvat dokumentit. Lue lisää Cloud Printista täältä.

 

Jos käytät lämpötulostimia ja kohtaat tulostusongelmia, löydät apua mahdollisesti Printers help pages -sivuiltamme. Etikettien tulostusongelmat liittyvät usein tulostimen asetuksiin, kalibrointiin, puuttuviin fontteihin jne.

 

Lähetettyjen lähetysten tietojen tallennus

Lähetetyt lähetykset säilytetään tietokannassa 90 päivän ajan. Yli 90 päivää vanhat lähetykset poistetaan joka yö, jotta tietokanta pysyy mahdollisimman kompaktina ja suorituskyky hyvänä. Lähetyksesi ovat kuitenkin saatavilla nShift Portalissa niin kauan kuin haluat. nShift Portalissa voit tarkastella lähetystietoja ja tilastoja sekä tehdä raportteja.

Contact nShift saadaksesi Portal-käyttäjätilin.

Lue lisää tietojen tallennuksesta Portalissa täältä.

 

 

Lisälukemista

Katso nämä artikkelit saadaksesi lisätietoja eri metodeista, vaihtoehdoista, objekteista ja kentistä, jotka ovat käytettävissä Shipment Serverille


Ei-tekninen johdanto Shipment Serveriin löytyy tästä artikkelista:

Yleiskatsaus kaikkiin Shipment Serveriin liittyviin artikkeleihin löytyy täältä.

Aiheeseen liittyvät artikkelit