Six Step Implementation Guide. January 2007

Transcription

1 Web Integrated Solutions Six Step Implementation Guide January 2007

2 Confidential and Proprietary The information contained in this Six Step Implementation Guide is confidential and proprietary to FedEx Corporate Services, Inc. and its affiliates (collectively "FedEx"). No part of this Six Step Implementation Guide may be distributed or disclosed in any form to any third party without written permission of FedEx. This guide is provided to you under and its use is subject to the terms and conditions of the FedEx API End User and/or Consultant License Agreement. The information in this document may be changed at any time without notice. Any conflict between either of these guides, the FedEx API End User and/or Consultant License Agreement, and the FedEx Service Guide shall be governed by the FedEx API End User and/or Consultant License Agreement and the FedEx Service Guide, in that order FedEx. FedEx and the FedEx logo are registered service marks. All rights reserved. Unpublished.

3 Welcome to FedEx Web Integrated Solutions The FedEx Web Integrated Solutions portfolio is comprised of two types of communication methods: FedEx Ship Manager Direct and FedEx Ship Manager API. Both of these protocols allow you to integrate FedEx functionality into your Internet/intranet applications by providing the flexibility you need for seamless implementation. The FedEx applications that can be integrated with both solutions include: Domestic and International Shipping Rating Tracking Signature Proof of Delivery Drop-Off Locator Courier Dispatch* Address Verification* Returns Management *Courier Dispatch and Address Verification documentation are available by request. Please contact your FedEx Account Executive for more information. WIS Solutions The FedEx Web Integrated Solutions portfolio offers two types of communication solutions: FedEx Ship Manager Direct: FSM Direct is a fully XML compatible solution that allows you to send transactions directly to the FedEx back-end systems using an HTTPS post method without having to download or use any software. FedEx will provide a set of specifications and examples to help with application development, however there are three criteria that must be met to use this solution: A working knowledge of HTTPS and Secure Socket Layering encryption Ability to provide a secure SSL connection to FedEx Ability to code to a designated transactional interface FSM Direct provides complete platform independence, unlike FSM API, which only supports Windows, UNIX, and Linux. FedEx Ship Manager API: FSM API is a fully XML compatible solution and is an alternative to FSM Direct. With FSM API, free Java-based communications software is provided, which will ease the amount of programming required as this software handles the applicable security, encryption, and authentication interaction required for Internet-based communications. The communication software provided with the FSM API solution is platform dependent on Microsoft Windows, UNIX, or Linux systems. FedEx Ship Manager API runs on the following operating systems: Microsoft 95/98/ME/NT/2000/XP Sun Solaris 2.6 or higher Red Hat Linux 6.2 Web Integrated Solutions - Six Step Implementation Guide, January

4 Once you have decided to use either FSM API or FSM Direct as your communication method to FedEx, you can choose from one of two transaction types: FedEx Tagged Transactions XML Transactions To complete implementation of FSM API/Direct, you will follow six steps: Step 1: Review Documentation (FSM API or FSM Direct) Step 2: Registration (FSM API or FSM Direct) Step 3: Download API and Configure Software (FSM API Only) Step 4: Development (FSM API or FSM Direct) Step 5: Test (FSM API or FSM Direct) Step 6: Certification (FSM API or FSM Direct) Step 1: Review Documentation (FSM API and FSM Direct) Before you begin development, you should familiarize yourself with the FSM API/Direct documentation. The following documents are available for your review: Title Direct/API? Tagged/XML? Tagged Transaction Guide Both Tagged Only Tagged Transaction Parser Both Tagged Only Guide XML Transaction Guide Both XML Only Tagged/XML Transaction Both Both Error Codes and Messages Direct Programmer s Guide Direct Only Both API Client Libraries API Only Both Developer s Guide Label Developer s Toolkit Both Both FSM API supports a variety of programming languages in VB.NET, Java, C++, Visual Basic, and ASP.NET. For more information, be sure to download a copy of the documentation and code samples from: To go directly to documentation: To go directly to code samples: Step 2: Registration (FSM API and FSM Direct) The registration process is initiated by selecting register here on the WIS page on fedex.com ( When you click the register here link, the following web page is displayed: Web Integrated Solutions - Six Step Implementation Guide, January

5 Web Integrated Solutions - Six Step Implementation Guide, January

6 Note: If you are a Consultant downloading the software for your client, you are required to provide your Client s Information within the form. After submitting this initial form, you will be prompted to provide your own information on another form. After you agree to the FedEx Automation Agreement, the following will occur: If you chose FSM API, you will be prompted to download the free communication software. If you chose FSM Direct, you will receive a Welcome with links to documentation. Step 3: Install and Configure FSM API (FSM API Only) After downloading the FSM API installer, you are ready to install the FSM API application. When you locate and execute the downloaded file, the following screens are displayed: Click Next. Web Integrated Solutions - Six Step Implementation Guide, January

7 Click Next. Make your selection and click Next. Web Integrated Solutions - Six Step Implementation Guide, January

8 Review the License Agreement. In order to proceed with the installation, click Yes if you accept the agreement. Enter your name and company name, and then click Next. Web Integrated Solutions - Six Step Implementation Guide, January

9 Determine destination location and click Next. If you have a Proxy Server, provide information requested. If not, leave blank. Web Integrated Solutions - Six Step Implementation Guide, January

10 Click Next. Select/add Program Folder or use default (FedEx Ship Manager API). Click Next. Click Finish. Web Integrated Solutions - Six Step Implementation Guide, January

11 FedEx Ship Manager API is now installed! Step 4: Development (FSM API and FSM Direct) After you have reviewed the WIS documentation for the application you chose, you are now ready to integrate WIS into your application. If you are in the pre-production stages of implementing a FedEx Web Integrated Solution and would like to speak with a FedEx Integration Consultant who can assist you in understanding the technical schematics associated with these solutions, please contact your FedEx Sales Executive or the FedEx Technical Support number below. You will be contacted by a WIS consultant within 3 business days. If you need technical assistance related to either WIS or FedEx in general, please contact the WIS Support Line at websupport@fedex.com or phone (keyword webapi). Step 5: Test (FSM API and FSM Direct) In order to submit either test or production transactions to the FedEx Gateway server, each transaction must contain both a FedEx Account Number and another unique identifier, a FedEx Meter number. You must send a Subscribe transaction request (supported by both the Tagged and XML Transaction sets) containing your Account Number and contact information. The reply transaction will contain your assigned FedEx Meter number and what services are authorized for your account Note: Before sending a Subscribe transaction to obtain a test meter number, you are required to send an e- mail to websupport@fedex.com requesting to have your FedEx account number set up in the FedEx test environment. This must include an attachment containing a few lines of source code that you have written to help FedEx Support identify the type of application you are implementing. Typically, you only need to submit a Subscribe transaction once after you are registered in the FedEx test environment, and once when you are certified to access the FedEx production environment. You will need to store these meter numbers in a file or database record where your application can access them for insertion into your formatted transactions. Once you have submitted your test access request, you will be notified by within 24 hours that you may now begin testing your custom API application. Note: Reference the API Tagged Transaction Guide or XML Transaction Guide for more information on the Subscribe and other available FedEx transactions. Step 6: Certification (FSM API and FSM Direct) The certification process consists of implementing test scripts which imitate true shipping, tracking, and rating scenarios. To confirm the ability of your application to process and generate accurate and scannable shipping labels, you will need to send shipping labels to FedEx for certification. Once you have completed development of your custom application, call FedEx Technical Support at (keyword: fsmapi) from 7am to 12 midnight CST Monday through Friday and 7am to 7pm Saturday to initiate the testing and certification process. Within 24 hours after speaking with FedEx Technical Support, you will receive an containing test scripts. These scripts provide hypothetical shipping and tracking scenarios for FedEx Express and Ground services and are designed to make sure Web Integrated Solutions - Six Step Implementation Guide, January

12 that your application is fully compatible with FedEx systems before you go to the live production environment. You must verify that your custom application can process these scripts appropriately. To complete certification, you will send sample shipping labels to FedEx. This test will ensure that the barcode on your labels can be processed and scanned by FedEx Operations. FedEx will evaluate the results of the test (usually within 72 hours of receipt of labels) and will then notify you if you are certified to go live with your custom application. Third Party Developer: If you are a third party developer who is not the end user of the application you are coding, you must also have your end user sign a FedEx Automation License Agreement which can be obtained by contacting websupport@fedex.com. An End-User License Agreement (EULA) will be ed to your customer who must sign this agreement before certification is complete. As a third party developer, you must also submit to FedEx a simple one-page operating scenario which clearly communicates the following: 1. Your intended use of the Web Integrated Solution: This statement should indicate whether you are developing a custom FedEx-enabled application for a single customer or if you intend to resell this application to your entire customer base. 2. Which FedEx functionality you have implemented: This statement should indicate what applications you have coded (for example: tracking, rating, shipping, dangerous goods, alcohol, international shipping). 3. End User Specific Information: This information should include the following: a. FedEx 9-digit account number b. Company name c. Company contact name d. Address e. City, state, postal code, country (if you are shipping outside the US) f. Phone g. h. Fax i. Printer model(s) to be utilized* j. How many of each printer model(s) will be utilized* k. Date anticipated for moving into production status *Only applicable to FedEx Ground and FedEx Home Delivery Services When you are ready to move to the FedEx production environment, your completed operating scenario to websupport@fedex.com. If you have any issues or questions regarding download, installation, testing, or certification, please contact WIS Technical Support at websupport@fedex.com or call Web Integrated Solutions - Six Step Implementation Guide, January