An Access Key provides your company access to the carrier system which holds the information you or your customers need to ship, rate, and track a package, among others.
Directions: If you do not have a User Profile, you need to open a User Profile to gain an Account number (Navigate to Account Summary, tap Open a Shipping Account, tap Open an Account today and proceed with creating your account).
Steps
- Log in to the carrier website (Note: refer to section below specific to each carrier)
- Note: If you do not have an account, sign up to establish your account. Once your account is created, open a carrier shipping account e.g. account number
- Update within Settings of the Admin Dashboard
- Tap Update button
- The key is now live for your Account
Carrier-specific directions
Refer to each item below for guidance on the steps included within the creation of the api key for each specific carrier.
DHL
- Go to Developer Center. Tip: register if no account previously, already exists.
- Go to Apps
- Tap Create An App
- Create App with App Name, Description, APIs, Add Tracking API (tap plus sign)
- Tap Create App Button, proceed to approved
- Tap Edit on the Apps List View for your app. Tap View
- On App. View Panel (top). In Credentials Section. Copy API Key, App Secret values.
- Update within Settings of the Admin Dashboard
- Tap Update button
- The key is now live for your Account
FedEx
- Go to Developer Resource Center.
- Tap text Get Production Key
- Proceed with Registration for Web Services Production Access
- Once you have completed the following form, go to Getting Started
- On the Developer Portal on the left side of the page, tap My Projects
- Tap + Create Project
- Select project project type from list of options. .. To create an API project, first let us know why you need API access dropdown menu. Tap “Ships with F. carrier and needs to integrate F. carrier APIs into their system”
- Select API(s) for your project. Select: Track API
- Select account, tap your account
- Read, confirm, acknowledge terms I would like to receive this notification and I have read, understand and agree to be bound by the F. Carrier Developer Portal License Agreement…
- Tap Next button. Proceed with configuration of the project.
- Create a Project. Define Project Name. Suggestion: Type: [Your company name] + Tracking API
- Select a country or territory. Suggestion: United States
- Tap Next
- Step 3 – Confirm details. Tap Accept Terms
- Tap Create
- Update within Settings of the Admin Dashboard
- Tap Update button
- The key is now live for your Account
UPS
- Open Developer Portal
- Tap Create Application button
- Tap Add Apps
- Enter details of new app. Choose from list of options. Integrate into my business, Enter account number, agree and confirm terms.
- Enter Contact Information
- Add App Details. App Name, Callback URL, Select Track API (any any others applicable)
- Add App Info/Credentials to form or Settings Page. Client ID, Client Secret, Callback URL, Billing Account Number. Tip: Use app url + /ups-callback as in example: https://app.example.com/ups-callback
- Update within Settings of the Admin Dashboard
- Tap Update button
- The key is now live for your Account