Step-by-step guides on how to obtain your FedEx API Key and API Secret Key
Important Reminders: You can browse the FedEx API homepage by visiting https://developer.fedex.com/api/en-us/home.html.If you do not have an account yet, you can sign up for one on the same page. However, you can log in using your credentials if you already have an account. FedEx Certification is a mandatory step for Ship API and Open Ship API before you can be utilized in the FedEx production environment. Click on this link https://developer.fedex.com/api/en-us/certification.html for label certification steps.
1. Create a project to get credentials
- After logging in to the FedEx Developer portal, navigate to the left-hand side and select “My Projects“. From there, choose “Create New Project” to begin the project creation process. Choose the appropriate reason for the API from the dropdown menu according to your needs, and provide a distinctive name for your project.
- Select the API(s) you want to include in your project
Add Address Validation, FedEx Locations Search, Global Trade, Open Ship, Postal Code Validation, Service Availability, Rates and Transit Times, Trade and Documents Upload and Ship API.
2. Configure project
Enter some project specifics, including name and shipping location.
- Give your project an identifiable name that is unique to your organization
- Select any countries you plan to ship within so that FedEx can assign you a test shipping account.
3. Confirm details
4. You can now see the API key (Client ID) and Secret Key (Client Secret) are visible in this window
5. Login to Connected Business Desktop Apps > Shipping > Setup > Carrier Plugin and open FedEx
- Enter the Account Number, Client ID, and Client Secret
- Test Mode (Checked) Server Token URL: https://apis-sandbox.fedex.com/oauth/token
- Live/Production Server Token URL: https://apis.fedex.com/oauth/token
Reminders: The "Test Mode" box must be checked if you want to run some test shipments otherwise it will connect to the Production URL and generate a production label regardless of whatever Server token URL entered.
- Wait for the FedEx confirmation email that the new project has been successfully created before testing Connected Business Shipping.
Generate Production Key
Reminders: FedEx Certification is a mandatory step for Ship API and Open Ship API before you can be utilized in the FedEx production environment. Click on this link https://developer.fedex.com/api/en-us/certification.html for label certification steps.
1. Click My Projects in the left-hand navigation
2. Click the necessary Project you created when setting up the Test Credentials
3. Switch to the Production Key tab and select the Account number. Click Next.
4. Once the key is ready, you'll be able to access it through the Production tab.
5. Login to Connected Business Desktop Apps > Shipping > Setup > Carrier Plugin and open FedEx
- Enter the Account Number, Client ID, and Client Secret
- Test Mode (Checked) Server Token URL: https://apis-sandbox.fedex.com/oauth/token
- Live/Production Server Token URL: https://apis.fedex.com/oauth/token
Reminders: The "Test Mode" box must be checked if you want to run some test shipments otherwise it will connect to the Production URL and generate a production label regardless of whatever Server token URL entered.
How to generate Track API Credentials
Starting October 2023 FedEx is now forcing to create separate API keys for Tracking API. We have added an option to manage separate keys in the "Carrier Plugin" details. It is optional if anyone has an older project setup with FedEx.
1. Create a project to get credentials for Track API
- After logging in to the FedEx Developer portal, navigate to the left-hand side and select “My Projects“. From there, choose “Create New Project” to begin the project creation process. Choose the appropriate reason for the API from the dropdown menu according to your needs, and provide a distinctive name for your project.
2. Select the Track API
3. Configure project
Enter some project specifics, including name and shipping location.
4. You can now see the TRACK API key (Client ID), Secret Key (Client Secret) and Account Number are visible in this window
5. Login to Connected Business Desktop Apps > Shipping > Setup > Carrier Plugin and open FedEx
- Enter the Account Number, Client ID, and Client Secret
- Test Mode (Checked) Server Token URL: https://apis-sandbox.fedex.com/oauth/token
- Live/Production Server Token URL: https://apis.fedex.com/oauth/token
Reminders: The "Test Mode" box must be checked if you want to run some test shipments otherwise it will connect to the Production URL and generate a production label regardless of whatever Server token URL entered.
