Widget Gränssnittsdokumentation. Version 1.14

Transkript

1 Widget Gränssnittsdokumentation Version 1.14

2 Datum: Sida 2 av 5 Revisionshistorik Version Datum Kommentarer Justeringar i kap 1, 3 och 4 i och med ny Widget version. Ny tjänst tillgänglig, Sök din sändning Referens. Nya riktlinjer för implementering av Widget, dynamisk bredd och https Justeringar gjorda i kap Justeringar gjorda i kap 3 och 4; locale Uppdateringar gjorda i kap 4; start_widget och hide_widget Första versionen Omstrukturering och omformulering av kapitel samt innehåll Uppdatering mindre justeringar efter granskning av Schenker 2(5)

3 Datum: Sida 3 av 5 INNEHÅLLSFÖRTECKNING REVISIONSHISTORIK WIDGET BESTÄLLNING INTEGRERING KONFIGURERING (5)

4 Datum: Sida 4 av 5 1 Widget Tjänsten ger kunder möjligheten att på ett enkelt sätt integrera DB Schenkers tjänster i widgetformat på sina egna webbsidor. Idag erbjuds fyra tjänster i widgetformat; Sök sändningsstatus, Sök paketombud, Sök din sänding - Referens och Nyheter. 2 Beställning Beställning sker via Efter att ha ansökt om DB Schenkers widget skickas en kundunik url till er med e-post. Denna url fungerar endast att integrera på den domän ni angav i ansökan, dvs om domännamn angivits i ansökan, fungerar widgeten endast att integrera på just Exempel på url: där <my-license-key> är er unika kod för just er domän. 3 Integrering DB Schenkers widget rekommenderas att inkluderas som en iframe på en webbsida. Exempel: <IFRAME src=" width="200" height="295" scrolling="no" frameborder="0" border="0" allowtransparency="true"></iframe> där <my-license-key> är er unika kod för just er domän. Tänk på att mindre än och större än tecknen runt licensnyckeln inte skall vara med i den färdiga koden. Widgeten är responsiv (dynamisk) på bredden och anpassar sig automatiskt till det utrymme som ges till den. Vi rekommenderar en bredd (width) på mellan 188 och 300. Höjden (height) bör inte vara under 295 för att den ska fungera som tänkt. 4 Konfigurering Widgeten kan konfigureras med följande parametrar: Parameter: locale start_widget Förklaring Bestämmer widgetens språk. sv för svenska en för engelska Anger vilken tjänst som skall visas vid start. Om ingen tjänst anges så startar widgeten vid menyn. tracking för Sök sändningsstatus parcel_delivery_point för Sök paketombud 4(5)

5 Datum: Sida 5 av 5 hide_widget shipment_references för Sök din sändning - Referens news för Nyheter Anger vilken tjänst som skall döljas. Alla tjänster utom Nyheter (parameter news ) går att dölja. tracking för Sök sändningsstatus) parcel_delivery_point för Sök paketombud shipment_references för Sök din sändning - Referens För att dölja flera tjänster, ange tjänsterna efter varandra, separerade med kommatecken (ej mellanslag). Exempel på olika konfigureringar: Widget på svenska: Widget på engelska: Widget med tjänst Sök sändningsstatus dold: hide_widget=tracking Widget med tjänst Sök paketombud dold: hide_widget=parcel_delivery_point Widget med tjänst Sök sändningsstatus och Sök paketombud dolda: hide_widget=tracking,parcel_delivery_point Widget med tjänst Sök sändningsstatus som första tjänst att visas: start_widget=tracking Widget med tjänst Sök paketombud som första tjänst att visas: start_widget=parcel_delivery_point Widget med tjänst Sök din sändning - Referens som första tjänst att visas: start_widget=shipment_references 5(5)