Getting Started

This section provides step-by-step instructions for creating and configuring accounts needed for the different shipping providers.

FedEx

Before starting to use this component, all developers must first register for these services with FedEx by visiting Developer Solution Center (DSC) at http://www.fedex.com/us/developer/product/resources.html and following the instructions. At the time of registration, a Developer Key, Password, Test Account Number, and a Test Meter Number are provided to you by FedEx. If you experience any problems during the registration process, you can send an email to websupport@fedex.com.

When obtaining an account from FedEx, the account should be for the Web Services XML based API. FedEx offers both an XML and SOAP based Web Services API. The component supports the XML based Web Services API.

FedEx supplies a complete online operating environment with which to test your applications against live FedEx servers. In order to execute test interactions, you must first include all credentials mentioned above in your code. This way, you can access FedEx Web Services and engage in real-time online testing in the FedEx hosted test environment by using this component. These credentials are your security elements and are not to be shared with anybody.

Once the Shipping Integrator components are integrated, your server communicates with the FedEx server over a secure SSL connection. You can connect directly to the FedEx back end systems using your own communications protocol.

When any of the Shipping Integrator components return a response, it will either return a successful response document or an error document.

Before moving to the production environment, you will have to go through the certification process with FedEx for the Ship services only (which is considered an advanced service by FedEx).

You do not need to go through the certificate process to use the standard services (Rates, Track, Locator). However, when using these services in the production environment, you will have to use the production credentials in all your requests.

Our component ensures a smooth transition during this process. It ensures that your implementation meets a number of requirements for safe, secure, and effective operation of your solution in the FedEx production environment. However, based on your needs, please note that the certification requirements differ based on whether you are a corporate or commercial developer, and whether you are implementing using the advanced or standard services.

The full version of Shipping Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package, you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.

Note to existing customers: If your current account is for the FedEx ShipManager Direct service, you will need to follow these same steps to register for the new version of the FedEx Web Services, as well as complete certification for Labels again.

UPS

The UPS components allow you access to the UPS on-line services, providing easy access to address verification, tracking information, shipping rates, and shipping time.

Once the Shipping Integrator components are integrated into your application, you can communicate with the UPS server over a secure SSL connection.

Before using these components, the user must contact UPS to obtain access to UPS OnLine Tools. For this, please visit https://www.ups.com/upsdeveloperkit and follow the steps as instructed on that page.

Please read the instructions carefully. You should register first, and after reviewing and accepting the UPS User Agreement, you should submit a request for an Access Key. After the request has been submitted, your Access Key will be emailed to the email address you provided to UPS during registration process. An Access Key provides access to UPS systems, which hold the information you or your customers need to ship, track, or rate a package.

This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. Sharing the security elements (UserId, Password, AccessKey, and AccountNumber) with third parties is strictly prohibited as expressed in the UPS Developer Agreement.

Each request requires specific processing based on the type; therefore, each component has a unique URL for connection purposes.

The following URLs may be used for testing:

USPS

The USPS components allow you access to the on-line services of the United States Postal Service (USPS). These provide easy access to shipping and tracking information.

Once the Shipping Integrator components are integrated, your server communicates through the USPS server over HTTP using XML.

Before using these components, the user must contact USPS to obtain credentials necessary to use USPS's online tools. To gain these credentials, please visit https://secure.shippingapis.com/registration/. Also, more information regarding USPS's online tools can be found here: http://www.usps.com/webtools/.

Endicia

When using the Endicia postage provider for the USPS components, you do not need credentials to test as Endicia's test servers do not check the credentials that you pass. You will however need to certify your labels with Endicia before getting production access. More information regarding Endicia can be found at http://www.endicia.com/Developers/LabelServer/.

To sign up for an account visit http://www.endicia.com/developer-resources/endicia-label-server-apis.

Canada Post

The Canada Post components allow you to access the on-line services of Canada Post. these provide easy access to rating, shipping, and tracking information.

Once you have integrated with the Shipping Integrator components, your server communicates directly with the Canada Post servers over HTTP using XML.

Before using the components, the user must contact Canada Post to obtain the necessary credentials to use Canada Post's APIs. To gain these credentials, please got to https://www.canadapost.ca/cpotools/apps/developers/home and click the Join button near the top of the page.