Widget Gränssnittsdokumentation. Version 1.13

Transkript

1 Widget Gränssnittsdokumentation Version 1.13

2 Datum: Sida 2 av 5 Revisionshistorik Version Datum Kommentarer Justeringar gjorda i kap Justeringar gjorda i kap 3 och 4; locale Uppdateringar gjorda i kap 4; start_widget och hide_widget Omstrukturering och omformulering av kapitel samt innehåll Uppdatering mindre justeringar efter granskning av Schenker Första versionen 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 externa kunder möjligheten att på ett enkelt sätt integrera DB Schenkers tjänster i widgetformat på sina egna webbsidor. Idag erbjuds tre tjänster i widgetformat; Sök sändningsstatus, Sök paketombud 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. 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. tracking för Sök sändningsstatus (standardval) parcel_delivery_point för Sök paketombud news för Nyheter 4(5)

5 Datum: Sida 5 av 5 hide_widget Anger vilken tjänst som skall döljas. Alla tjänster utom Nyheter (parameter news ) går att dölja. tracking (Sök sändningsstatus) parcel_delivery_point (Sök paketombud) 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 5(5)