web integration solutions

Web Integration Solutions

Overview

Web Integration Solutions Overview, v 8.5

Legal Terms and Conditions


Legal Terms and Conditions Use of this system constitutes your agreement to the service conditions in the current FedEx Service Guide, available upon request. FedEx will not be responsible for any claim in excess of $100 per package, whether the result of loss, damage, delay, non-delivery, misdelivery, or misinformation, unless you declare a higher value, pay an additional charge, document your actual loss, and file a timely claim. Limitations found in the current FedEx Service Guide apply. Your right to recover from FedEx for any loss, including intrinsic value of the package, loss of sales, income interest, profit, attorney’s fees, cost and other forms of damage whether direct, incidental, consequential, or special is limited to the greater of $100 or the authorized declared value. Recovery cannot exceed actual documented loss. Maximum for items of extraordinary value is $500, e.g. jewelry, precious metals, negotiable instruments, and other items listed in our service guide. Written items must be filed within strict time limits, see current FedEx Service Guide. FedEx will not be liable for loss or damage to prohibited items in any event or for your acts or omissions, including, without limitation, improper or insufficient packaging, securing, marking or addressing, or the acts or omissions, or the recipient, or anyone else with an interest in the package. To obtain information regarding how to file a claim or to obtain a FedEx Service Guide, please call 1.800.Go.FedEx (1.800.463.3339).

Table of Contents


Table of Contents

Revision History..................................................................................................................................1

Introduction .........................................................................................................................................2

WEB INTEGRATION SOLUTIONS AT A GLANCE................................................................................................................ 2 FedEx Ship Manager API .................................................................................................................................................... 2 Web Integration Solutions Features .................................................................................................................................... 3 Web Integration now offers Returns processing ................................................................................................................. 3 Web Integration Options...................................................................................................................................................... 4

WHERE TO FIND INFORMATION ......................................................................................................................................... 4 The README File (FSM API only)...................................................................................................................................... 4 FAQ - Frequently Asked Questions..................................................................................................................................... 4 Troubleshooting Guide ........................................................................................................................................................ 4 Additional Documents and References ............................................................................................................................... 4 Hotline Services................................................................................................................................................................... 5 Local URLs .......................................................................................................................................................................... 6

What’s New..........................................................................................................................................7

Referenced Documents......................................................................................................................8

Chapter 1 Integration and Certification.............................................................................................9

BEFORE YOU BEGIN ............................................................................................................................................................ 9 Registration.......................................................................................................................................................................... 9 Integration and Certification................................................................................................................................................. 9 Subscribing.......................................................................................................................................................................... 9

Chapter 2 FedEx Ship Manager API Installation ............................................................................10

INSTALLING YOUR SOFTWARE ........................................................................................................................................ 10 File Location and Download .............................................................................................................................................. 10 System Requirements ....................................................................................................................................................... 10 Platform Selection ............................................................................................................................................................. 11 Windows 95/98, Windows NT, Windows 2000, Windows Me, and Microsoft XP Installation ........................................... 11 UNIX / Linux Installation .................................................................................................................................................... 11

INSTALLED DIRECTORY FILES ......................................................................................................................................... 11 Windows ............................................................................................................................................................................ 11 UNIX / Linux ...................................................................................................................................................................... 11

Chapter 3 Development Guide for FSM API Integration ................................................................13

THE API ................................................................................................................................................................................ 13 API Components ............................................................................................................................................................... 13 ATOM ................................................................................................................................................................................ 13 Running Multiple Instances of ATOM................................................................................................................................ 13

USING THE API – WITH C/C++ OR VB............................................................................................................................... 14

Table of Contents


USING THE API – WITH C/C++ OR VB............................................................................................................................... 14

USING THE API – WITH JAVA............................................................................................................................................. 14

DEVELOPMENT AND TESTING.......................................................................................................................................... 15 The Development Process ................................................................................................................................................ 15

Acronyms ..........................................................................................................................................16

Index ..................................................................................................................................................17

Revision History

Web Integration Solutions Overview, v 8.5 1

Revision History

Version Date Section Description v 8.5 07/28/04 Referenced Documents Updated the Referenced Documents section. v v

Introduction


Introduction

Web Integration Solutions at a Glance FedEx has been a leader in the automation of shipping for over 15 years. During that period of time, FedEx has developed a variety of software and hardware systems to make it easier and more efficient for our customers to ship their packages. In a few short years, these systems have evolved from desktop computer systems to Internet-based shipping and tracking systems. Web Integration Solutions were designed to provide you with comprehensive tools to assist in your automated shipping and tracking deployment efforts. Welcome to Web Integration Solutions!

NOTE: Users unfamiliar with the features of FedEx shipping and tracking should visit the FedEx Home page at www.fedex.com and view these features.

FedEx Ship Manager API communicates with FedEx systems to perform shipping and tracking functions, so the results obtained from using FedEx Ship Manager API are similar to those of FedEx Ship Manager @ fedex.com and FedEx's Internet web site tracking. FedEx Ship Manager API An API is a set of interface functions available to other computer applications. FedEx Ship Manager API allows you to ship with (and track against) both FedEx Express and FedEx Ground. This document explains the FedEx Ship Manager API system of automated shipping. You may integrate functions for shipping and tracking into your own computer systems using a variety of programming languages and tools. These programming languages and tools include: C or C++ Visual Basic Java VB Script or Java Script

FedEx Ship Manager API is a powerful set of tools that provide a key advantage to FedEx customers with specific shipping and tracking needs such as order entry, fulfillment, and other business-related activities. These tools can be used for creating electronic catalogs, shipping applications on your corporate Intranet, or other in-house shipping and tracking applications. FedEx Ship Manager Direct The FSM Direct solution gives customers an alternative to the FSM API by allowing them to send transactions directly to the FedEx back end systems via HTTPS, without having to download software on their systems. FedEx will provide a set of guidelines and examples to help with the development of this application. There are three criteria that must be met to use this solution:

1. A working knowledge of HTTPS and Secure SocketLayering encryption 2. Ability to provide a secure SSL connection to FedEx 3. Ability to code to a designated transactional interface

FSM Direct provides complete platform independence, unlike FSM API which only supports Windows, Unix, or Linux.

http://www.fedex.com/

Introduction


3

NOTE: Technical support will be limited due to the vast knowledge needed to address issues from any platform. Once your application has been developed and it is time to connect to FedEx, technical support will be available.

Web Integration Solutions Features Some of the features included in the FedEx Ship Manager API and FedEx Ship Manager Direct are: Registration and authentication for the enterprise US domestic shipping with FedEx Express and FedEx Ground US export shipping International shipping for selected countries Laser and thermal printer generated shipping labels Courtesy rate quotes Collect on delivery (COD), dangerous goods, and dry ice shipment support for U.S. domestic Shipment cancellation option Track by Number Track by Reference Drop-off Locator* Signature Proof of Delivery* POD Notification Alert* Windows, Linux, and Sun Solaris Unix support for the FedEx Ship Manager API

*FedEx Ship Manager Direct is platform independent

NOTE: International Controlled Exports cannot be shipped using FedEx Ship Manager API. International Controlled Exports include State Department Licenses, ATA Carnet, Drawback Claims, Temporary Importation Bonds, In-bond Shipments, Certificate of Registration Shipments, Drug Enforcement Agency Shipments, or any license or permit requiring US Customs review prior to export. Please refer to the FedEx International tools found at: http://www.fedex.com/us/international/?link=41 or call 1.800.Go.Fedex and ask for Freight Services.

Web Integration now offers Returns processing The ability to process Return shipments is now available in the FedEx Ship Manager API and FedEx Ship Manager Direct products. This will allow customers to integrate a returns process into their current shipping processes to improve their customer service, reporting, and cost-controlling that comes from the additional insight into customers’ shipping cycles. There are several ways of handling a return shipment with FedEx: Print a return label for Express or Ground - create a label in advance to accompany an outgoing shipment Online label - create a return label from FedEx that can be emailed directly to the return shipper to print on their local

printer and placed on the package Express Tag - request a return label for Express shipments that will initiate a pick-up as well, the courier will print the

label at the time of pick-up Ground Call Tag - request a return label for Ground shipments that will initiate a pick-up as well, the courier will bring

the label and place it on the package at the time of pick-up Track by RMA - when a return shipment is created a Return Authorization Number may be generated, you can now

track that shipment by the Return Materials Authorization (RMA) number as well as the regular tracking number

Introduction


4

Web Integration Options The Web Integration Solutions can be integrated into your business applications in a variety of ways: Corporate Developer: You are a FedEx customer planning to integrate FedEx shipping or tracking services into your

online environment and supply chain systems with the assistance of your internal Technology Development Team. Consultants, Web Designers, System Integrators: You are a Consultant, Web Designer, or Systems Integrator

planning to integrate FedEx shipping or tracking services into your client's online environment or supply chain systems. These systems are not for resale or redistribution.

To learn more about this program, or to download the FedEx Ship Manager API product go to:

http://www.fedex.com/us/solutions/wis/index.html.

Where to Find Information The following information sources will assist you with the Web Integration Solutions: The README File (FSM API only) The README file (readme.txt) contains a 'packing list' of items included in a FedEx Ship Manager API installation, as well as important release notes. Under Windows 95/98, Windows 2000, Windows Me, Microsoft XP, or NT 4.0, you will find a shortcut to it in Programs/FedEx Ship Manager API/readme. FAQ - Frequently Asked Questions This URL http://www.fedex.com/us/solutions/shipapi/faq.html will take you directly to the FedEx Ship Manager API FAQ page. Here you will find questions and answers for Business, Technical, or implementation related offerings. Make sure you periodically check this web site for updates and other useful information which may have been added since your last visit. Troubleshooting Guide The FedEx Ship Manager API product offers a comprehensive program error routine that alerts the customer when required fields are not entered for a successful shipping or tracking transaction. A complete listing of error messages and definitions is provided in the FedEx Ship Manager API Client and Label Error Codes and Messages document. Additional Documents and References FedEx API Client Libraries Developer's Guide – FedExAPIClient.pdf FedEx API Tagged Transaction Parser Developer's Guide – FedExTagTransParser.pdf FedEx API Label Extensions Developer's Guide – FedExLblexts.pdf FedEx Ship Manager API Client and Label Error Codes and Messages - FedExAPIErrors.pdf FedEx Ship Manager Tagged Transaction Guide – FedExTagTransGuide.pdf FedEx Ship Manager XML Transaction Guide – FedExXMLTransGuide.pdf

http://www.fedex.com/us/solutions/wis/index.html

http://www.fedex.com/us/solutions/shipapi/faq.html

Introduction


5

Hotline Services If you or your customers need technical assistance, please follow the escalation process in the order listed below: • Please reference the Technical Support FAQ’s at: URL http://www.fedex.com/us/solutions/shipapi/faq.html. • If additional assistance is needed, please email Technical Support at: [email protected] • For Domestic technical support, please call 1.800.810.9073, Monday-Friday 7-10 p.m., Saturday 7-7 p.m. (CST). • For International technical support in one of the following countries, please call the appropriate number below:

Country Contact Number Contact E-mail Operating Hours AE 9714 6026234 8:00 – 20:00 GMT Argentina 0800-222-0037 [email protected] Australia Contact local FedEx rep. N/A Austria 0800 387 218 8:00 – 20:00 GMT Bahrain 97 14 602 6234 8:00 – 18:00 GMT Belgium/ Luxembourg 0800 131 83

8:00 – 20:00 GMT

Brazil 0 800 160 007 [email protected] 9:00 – 18:00 GMT Chile 0-800-200-662 [email protected] 9:00 – 18:00 GMT Colombia 980 9 520140 [email protected] 9:00 – 18:00 GMT Costa Rica 0-800-052-1090 9:00 – 18:00 GMT Dominican Republic 1 800 3542323 [email protected] France 0800 907 605 8:00 – 20:00 GMT Hong Kong Contact local FedEx rep. N/A Germany 0800 022 5125 8:00 – 20:00 GMT India 97 14 602 6234 8:00 – 18:00 GMT Ireland 1800 553 222 8:30 – 17:30 GMT Israel Contact local FedEx rep. N/A Italy 800 876 136 8:00 – 20:00 GMT Japan Contact local FedEx rep. N/A Kuwait 97 14 602 6234 8:00 – 18:00 GMT Malaysia Contact local FedEx rep. N/A Mexico 01800 710 7910 [email protected] 9:00 – 18:00 GMT Netherlands 0800 0225125 8:00 – 20:00 GMT Panama 507 271 3838 [email protected] 9:00 – 18:00 GMT Philippines Contact local FedEx rep. N/A Puerto Rico 800-810-9073 [email protected] 9:00 – 18:00 GMT Singapore Contact local FedEx rep. N/A South Africa Contact local FedEx rep. N/A Spain 900 993273 8:00 – 20:00 GMT Sweden Contact local FedEx rep. N/A Switzerland 0800 554390 8:00 – 20:00 GMT Taiwan Contact local FedEx rep. N/A UAE 97 14 602 6234 8:00 – 18:00 GMT

http://www.fedex.com/us/solutions/shipapi/faq.html

mailto:[email protected]








Introduction


6

Country Contact Number Contact E-mail Operating Hours UK 0800 387 218 8:30 – 17:30 GMT Uruguay 0004-055-333 [email protected]

Venezuela 1-800-111-21-1-800-354-2323 [email protected] 9:00 – 18:00 GMT

Local URLs

Country Local URLs

EEUU http://www.fedex.com/globaldeveloper/shipapi

Argentina http://www.fedex.com/ar/ebusiness/globaldeveloper/shipapi/

Brazil http://www.fedex.com/br/ebusiness/globaldeveloper/shipapi/

Chile http://www.fedex.com/cl/ebusiness/globaldeveloper/shipapi/

Colombia http://www.fedex.com/co/ebusiness/globaldeveloper/shipapi/

Mexico http://www.fedex.com/mx/ebusiness/globaldeveloper/shipapi

Panama http://www.fedex.com/pa/ebusiness/globaldeveloper/shipapi/

Puerto Rico http://www.fedex.com/pr/ebusiness/globaldeveloper/shipapi/ Dominican Republic http://www.fedex.com/do/ebusiness/globaldeveloper/shipapi/

Uruguay http://www.fedex.com/uy/ebusiness/globaldeveloper/shipapi/

Venezuela http://www.fedex.com/ve/ebusiness/globaldeveloper/shipapi/



http://www.fedex.com/mx/ebusiness/globaldeveloper/shipapi

What’s New


What’s New

Version Feature Description v

Referenced Documents


Referenced Documents

Title Version/ Revision Location

FedEx Ship Manager API Client Libraries Developer's Guide

v 8.5 www.fedex.com/us/solutions/fsmapi.html

FedEx Ship Manager API Tagged Transaction Parser Developer's Guide


Ship Manager API Label Extensions Developer’s Guide


FedEx Ship Manager API Client and Label Error Codes and Messages


FedEx Ship Manager API Tagged Transaction Error Codes and Messages


FedEx Ship Manager API Tagged Transaction Guide


FedEx Ship Manager XML Transaction Guide


FedEx Ship Manager API Transaction Parser Developer’s Guide


FedEx Service Guide current Call 1.800.Go.FedEx (1.800.463.3339).

http://www.fedex.com/us/solutions/fsmapi.html








Chapter 1: Integration and Certification


Chapter 1 Integration and Certification

Before You Begin Registration To register for a Web Integration Solution, go to http://www.fedex.com/us/solutions/wis/index.html and complete the brief registration form. Integration and Certification Who must certify All developers wishing to submit transactions to FedEx via the FSM API or FSM Direct must complete the registration and certification process. If you are a corporate developer or consultant developing for internal use, go to http://www.fedex.com/us/solutions/wis/pdf/FedExAPIImplementationOverview.pdf?link=4 for integration and certification information, or call FedEx Technical Support at 1.800.810.9073 from 7:00 a.m. to 12:00 a.m. Central time to initiate the certification process. Subscribing 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 request transaction (Common Transaction Set (CTS) Transaction Type 211) containing your Account Number and contact information. The response transaction (CTS Transaction Type 311) will contain your assigned FedEx Meter Number, and what Services authorized for that particular FedEx account. Typically, you need only submit this transaction once after you are registered in the FedEx Test Environment, and once when you are certified to access the FedEx Production Environment. You should be careful to record the Meter Number and the Account Number with which it is associated, and not lose them. You will need to store them in a file or database record, where your application can access them for insertion into your formatted transactions. Reference the FedEx Ship Manager API Tagged Transaction Guide or FedEx Ship Manager XML Transaction Guide for more information on the Subscribe and other available FedEx transactions.

http://www.fedex.com/us/solutions/wis/index.html

http://www.fedex.com/globaldeveloper/shipapi/implementation.pdf?link=4

Chapter 2: FedEx Ship Manager API Installation


Chapter 2 FedEx Ship Manager API Installation

Installing Your Software File Location and Download The FedEx Ship Manager API suite allows you the flexibility and control of selecting where you want the files to be installed on your system during the installation process. System Requirements

Hardware PC: Intel Pentium class PC with 32 MB RAM and 14MB of free disk space is recommended for Windows 95, 98 and

ME platforms. Intel Pentium class PC with 64 MB RAM is recommended for Windows 2000, Windows NT, and Microsoft XP.

UNIX Server: Sun Solaris UNIX 2.6 or greater is required. OR LINUX Server: Linux Red Hat 6.2 is required. Printer : Laser printer or Thermal Eltron Orion/Eclipse Zebra ZPL UNIMARK

Software

Operating systems: FedEx Ship Manager API supports the following: Microsoft Windows 95 (For Windows 95 you must also have Winsock v2.0) Microsoft Windows NT Microsoft Windows 98 Microsoft Windows 2000 Microsoft Windows Me Microsoft XP Linux Red Hat 6.2 Sun Solaris UNIX 2.6 or greater

Java Runtime Environment: Version 1.3 or higher is required. Browsers: You must have an Internet connection either through an Internet Service Provider (ISP) or through a corporate proxy server or firewall system. Supported browsers are: Netscape v 2.0 or higher Microsoft Internet Explorer v 3.1 or higher.



11

Platform Selection During the installation process, you will be asked to select the appropriate platform for the FedEx Ship Manager API installation. You will download a compressed file containing the various files comprising the FedEx Ship Manager API product. If you choose Microsoft Windows 95/98, Microsoft Windows NT, Microsoft Windows 2000, Microsoft Me, or Microsoft

XP you will receive a self-extracting archive with an .exe extension. If you choose Sun Solaris UNIX or Linux, you will receive a .tar file.

Windows 95/98, Windows NT, Windows 2000, Windows Me, and Microsoft XP Installation From Windows Explorer, run the self-extracting executable program by double clicking on fdxapiw32.exe and follow the instructions. UNIX / Linux Installation The Sun Solaris UNIX version of FedEx Ship Manager API software will be downloaded as a tar file called fxapisol.tar. The Linux version is called fxapilin.tar. Copy the tar file into your user directory and execute the tar utility with the command tar –xvf filename where filename is the name of the .tar file you downloaded.

Installed Directory Files Windows The FedEx Ship Manager API software package will create these subdirectories in the chosen install directory:

Directory Contents \agreements FedEx Consultant and ISV End User License Agreements

\ATOM ATOM transaction manager and router \help FedEx Ship Manager API Help Files \java\help FedEx Ship Manager API Java Class help files \java\jre Java Runtime Environment installer \java\lib FedEx Ship Manager API Java Class files \labels Label Extension Component support files \win32\bin FedExAPIClient.dll, FDXParser.dll, lblexts.dll \win32\help Documentation for FSM API \win32\include .dll header files \win32\sample A sample program using the FedExAPIClient.dll, FDXParser.dll, and lblexts.dll

UNIX / Linux

Directory Contents \fedexapi Readme.txt, License agreement, and version files \fedexapi\ATOM ATOM transaction manager and router \fedexapi\help FedEx Ship Manager API Help Files \fedexapi\include User include files



12

Directory Contents \fedexapi\java Text documents and Java example \fedexapi\java\bin FedEx Ship Manager API Jar files \fedexapi\java\javadocs FedEx Ship Manager API Java Class help files \fedexapi\\labels Label Extension Component support files \fedexapi\lib Shared and static libraries for all FSM API components \fedexapi\webetest A sample program using the FedExAPIClient, FDXParser, and lblexts components

Chapter 3: Development Guide for FSM API Integration


Chapter 3 Development Guide for FSM API Integration The API API Components The FedEx Ship Manager API is more than a library. When you install the API on a machine, other components are installed as well. The Windows version of the API includes three Dynamic Link Libraries (DLL’s) which contain the functions that you will call from your application. The Solaris and Linux versions include shared and static copies of each library. All OS versions include the Java version of the API. Which are contained in a .jar file. ATOM The FedExAPIClient library (or Java class) communicates via TCP/IP with a program or service called ATOM. As installed, ATOM routes all transasctions to remote FedEx servers, and handles any necessary SSL encryption. However, ATOM can in certain advanced configurations route different transactions to different servers. It can handle an unlimited number of attached clients and route transactions to up to ten different back-end servers, whether they are local or remote. Windows Users: To configure ATOM, click the Start button and go to Programs -> FedEx Ship Manager API ->ATOM View. This GUI allows Atom’s password and configurations to be changed. ATOM View can also start and shutdown Atom for Win 95/98/ME users. For NT/2000/XP users, Atom runs as a service. Therefore, it must be started and stopped from the Service Manager control panel. UNIX / Linux Users: Basic Scripts For Starting and Stopping ATOM: • To start ATOM, go to the ATOM subdirectory and type "Aatom start". • To stop ATOM, go to the ATOM subdirectory and type "Aatom stop". • To find the status of ATOM, go to the ATOM subdirectory and type "Aatom status". This will give the number of instances of ATOM presently running. Also note that there is a configuration file called config.ini that will be installed in your ATOM directory. This file must be edited to set/change any values to the appropriate settings. ATOM will need to be stopped and re-started for the changes to take effect. Running Multiple Instances of ATOM Multiple instances of ATOM can run on the same system. It is important to note that each instance should have its own unique AtomAdminPort and Port_1 settings. If you violate this condition and try to run multiple instances having these two settings the same, you will find that only one instance works. The other instance will abort, unable to open the necessary TCP/IP ports. ATOM can also be deployed as separate installations on different servers to help segment the flow of data across your LAN and to help performance in some cases. While the number of client connections ATOM can accept is unlimited, the resources of the computer running ATOM will dictate the performance observed. Dividing large numbers of client applications into groups and configuring each group to communicate to a separate ATOM service will improve performance in increased load situations.



14

Using the API – with C/C++ or VB In Windows, the API components are DLL’s that contain both a regular C function interface and a COM interface. In Solaris and Linux, both a shared and a static library for each component are available. Construct Request Create a request transaction in a buffer in accordance with the syntactic and semantic rules of the transaction set to which the transaction belongs, so the appropriate business server at FedEx can interpret the transaction. The FDXParser component can help construct and parse the transactions. Reference the FedEx Ship Manager API Transaction Parser Developer’s Guide for more information. Pass Request through Transaction Call Pass the transaction to the FedExAPITransaction function, and wait for a response from the FedEx Gateway server. All Transactions are conducted in synchronous mode, meaning you send a request then wait for the response. Parse Response Parse and interpret the response transaction according to the syntactic and semantic rules of its transaction set, resulting in a set of data items, again the FDXParser component will make this easier. Distribute Response Data Items Copy those data items into database records or other locations, as appropriate. If Shipping, Produce a Shipping Label If this is a shipping transaction, depending on which kind of label you have requested, pass the request and response transaction buffers to the Lblexts component for printing, displaying in a browser window, or saving to a file for later printing or browsing. Reference the FedEx Ship Manager API Label Extensions Developer’s Guide for more information. When a Ship a Package or Signature Proof of Delivery (SPOD) transaction is performed, the data necessary for producing a shipping label (and possibly a COD return label) or a SPOD letter is returned in one or more fields. The kind of label data returned depends on the printer type and format specified in your Ship request. A Shipping Label Extensions library is provided to help you print labels and SPOD letters, but if it does not fit your needs, you can handle extracting and printing the label data yourself. Reference the FedEx Ship Manager API Label Extensions Developer’s Guide for more information.

Using the API – with Java If you are using the Java version the API methods are in the FedExAPI.jar, FDXParser.jar, and Jlblexts.jar files. These are static methods and can be called without having to instantiate the class. Examine the JavaDocs in the Java\Help directory for more information.



15

Development and Testing The Development Process To create an application using the FedEx Ship Manager API or FedEx Ship Manager Direct, follow these steps:

1. Identify the production platform and system under which the application will run, and confirm that the API is compatible with them.

2. Analyze the application in light of the API or Direct documentation to determine exactly how and where you need to integrate the API or Direct into it.

3. Determine what development resources will be needed, such as compilers and editors. 4. Ensure that the identified system has Internet connectivity. 5. Install or create your own API on a development system that mirrors the production system. Upon initial

installation of this API, any transactions processed are directed to a test server. You must integrate the API or Direct solution into your application, test the application, and receive FedEx approval via the certification process prior to processing live transactions.

6. Study the descriptions of the various functions, and make sure that you have a thorough understanding of the appropriate code sample for the language in which you will be working.

7. Familiarize yourself with the tagged or XML transaction syntax rules and the content of the particular request transactions that you will be submitting (and their corresponding responses).

8. If you will be performing shipping transactions, determine which option for producing shipping labels (waybills) is most appropriate for your needs, and familiarize yourself with the steps required for that option.

9. Design a plan to determine what programming is needed to integrate the API into your application. 10. Perform the necessary development to create the desired application. 11. Send an email to [email protected]. Request to be set up for testing. Test your application. 12. Upon completion of testing your application, you must certify your application. See Chapter 1 of this document for

certification requirements.


Acronyms


Acronyms

API Application Programming Interface – An interface between the operating system and application programs.

ATA Airport to Airport ATOM Any Transport over MPLS COD Collect on Delivery

COM Component Object Model – a model used by software developers to create components tjat cam be reused easily with other objects. The model specifies the interfaces between component object so that the software application can be built out of interchangeable components.

CTS Common Transaction Set DLL Dynamic Link Library FAQ Frequently Asked Questions FSM FedEx Ship Manager

HTML HyperText Markup Language – The language used to create World Wide Web pages, with hyperlinks and markup for text formatting.

HTTP HyperText Transfer Protocol

LPT Line Print Terminal – The usual designation for a parallel port connection to a printer or other device.

MB Megabyte MPLS Multiprotocol Label Switching

OS Operating System PNG Portable Network Graphics bitmap (filename extension) RAM Random Access Memory RMA Return Materials Authorization

SPOD Signature Proof of Delivery

SSL Secure Socket Layer – A protocol for transmitting private documents via the Internet. By convention, URLs that require an SSL connection start with https: instead of http:.

URL Uniform Resource Locator – An internet address which tells a browser where to find an internet resource.

USB Universal Serial Bus VB Visual Basic (a Microsoft programming language).

XML Extensible Markup Language

Index


Index

A Acronyms, 16 API

using with C/C++ or VB, 14 using with Java, 14

ATOM, 13 running multiple instances, 13

C Compatible programming languages, 2

D Development process, 15 Document locations, 8

F FAQ, 4 Features, 3 FSM API, 2 FSM Direct, 2

H Hotline Services, 5

I Installation

API components, 13

Directory files installed, 11 platform selection, 11 selecting your operating system, 11

Installing your software, 10 Integration and Certification, 9

L Local URLs, 6

R README file, 4 Referenced Documents, 8 Registration, 9 Returns processing, 3 Revision History, 1

S Subscribing, 9 System Requirements

hardware, 10 software, 10

W Web integration options, 4 What's New, 7