- Web developers to integrate parcel shipping with their web based application
- Integrate the interactive ShipRush visual interface with browser based applications such as eCommerce using familiar HTML technologies
The ShipRush Browser Plugin Development Kit is designed to offer web developers an easy integration of the multi-carrier ShipRush visual interface with web browser based applications. Integration of ShipRush to the web application can be done using familiar HTML development tools.
By using the ShipRush visual interface, developers get all the benefits of ShipRush that we’ve coded (such as multi-parcel shipments, scale integration, support for multiple printer types, viewing all carrier services, estimating cost before shipment, reprinting labels, deleting shipments, viewing shipping history, etc.) without having to code each of these elements themselves.
Please note, the ShipRush Browser Plugin is a post-sale shipment facilitation tool to be used by the “shipper” to create shipping labels. It is not designed as a customer/buyer-facing shipping tool or pre-sale rate calculator.
Once the developer has used the free developer kit to write an integration with their web application, the ‘shipper’ can install the ShipRush client on their workstation. By clicking on a ‘ship’ link in the web application, the ShipRush application will open, and ‘ship to’ data will flow from the web application to the ShipRush shipping form, allowing them to easily print a shipping label. The integration between the web application and ShipRush can be unidirectional (print a shipping label only), or bi-directional (print a label, and return shipping data to the application).
Ways to use the Browser Plug-in
Simple & Unidirectional
This is the drop-dead-fastest-easiest way to get shipping into a web store. By simply extending your application with “ShipRush-style” URL’s, your page can have “Ship” links that pop up ShipRush with all the data pre-filled. Benefits: Quick & simple. No real code to write, just extend your current pages. Even offer automatic “silent” shipping (the user just clicks, and a label prints, with no prompting!). Issues: No write-back to your application. Possible web page bloat.
“GET API” Based
You code a simple API that serves up the Shipment XML in response to a GET request (e.g. GET https://YourApp.com/ServeShipmentXML.php?OrderNumber=123456). Your web pages then surface links like this:
Benefits: Simple, use existing coding skills and business logic. No bloat of pages. Issue: No write back.
You code a small API entry point so ShipRush can get and post back shipment information. For example, you create a page that functions as follows:
https://YourApp.com/Shipping.php?verb=GET;OrderNumber=1111 // Returns ShipRush Shipment XML
https://YourApp.com/Shipping.php?verb=SET;OrderNumber=1111 // Takes Shipment XML in the body of the tracking number, cost, etc.
Benefits: Full bidirectional integration. Support as many ShipRush features as you like. Use the ShipRush UI to let the user fill in the blanks.
Frequently Asked Questions
What is ShipRush?
What is the ShipRush Browser Plugin?
How does the plugin compare to the ShipRush SDK?
How does the plugin compare to ShipRush SQL?
The Browser Plugin lets ShipRush interact with web applications using normal internet protocols (like HTTP, XML & REST) without needing to access the database directly. Rather, the access is through the web application layer.
What are the benefits of using the Plugin?
Use standard web technologies and coding skills: XML, HTTP, and HTML.
What programming languages can be used?
Anything that can create HTML, and serve and digest XML! The developer kit includes samples in PHP, .NET and Java. Developers have used C++ and other tools in their web applications. Ruby and other tools will work fine (as long as you can read the PHP sample code).