Setup ODFL API Access

Introduction

This guide will explain how to configure ODFL credentials for both client and TMS users.

Helpful contacts:

  • Web & API Oncall Mailbox - Web&APIOncall@odfl.com
    • This contact is for general API questions/permissions.

Hazmat

  • Hazmat pickups are allowed for this carrier 

Client Credentials:

  • Obtain an LOA for the client and send it to your ODFL carrier rep.
  • Navigate to Company Management and select the client.
  • Find the Credential panel and click the Add (+) button.
    emptyCredential.png
    • Enter Old Dominion API for the name.
    • Choose API Key for the credential type.
    • Turn on the Production switch if you are ready to make pickup requests.
    • Set Old Dominion Freight Line (ODFL) as the carrier.
    • Enter the client's ODFL Account Number for the Account Number.
    • Click Create Credential.

TMS Users:

As a TMS user, you will need to set up 2 accounts with ODFL: an ODFL4me account, and a developer portal account.

  • ODFL4me Account:
    • To set up an ODFL4me account, go to the ODFL homepage and select sign up in the upper right-hand corner.
    • Fill out the required information (denoted with a '*').
      ODFL4meSignup.png
    • Click register.
      • Note: After clicking register, a customer service representative will contact you within the next business day to confirm registration.
  • Developer Portal Account:
    • To set up a Developer Portal account, go to the ODFL Developer Network and select Signup in the upper right-hand corner.
    • Fill out the required information (denoted with a '*').

      devPortalSetup.png
    • Enter the captcha, accept the disclaimer, and press Register Now.
      • Note: Account registration can take up to 1 business day.

Once both accounts are set up, it's time to create an application in the developer portal. Before you begin this step, send an email to the Web & API Oncall Mailbox asking for the following API permissions to be added to your Developer Portal account: REST Token API, REST Tracking API, and REST Pickup API. These APIs require special permissions to use, and without it, they will not show as an option when creating the application.

  • Log in to your Developer Portal account.
  • Navigate to the Applications page.
    applications.png

  • Click the Add Application button.
    addApplication.png

    • Enter a name for your application in the Name field.
    • Select Desktop for the Platform drop-down.

      addAPIToApp.png
    • For each API, select the API from the Add APIs drop-down, and agree to the terms and conditions.
      • You will want to do this for Token, Tracking, and Pickup
    • When all APIs have been added, under the Plan Change column, request to change each one to Production Plan.

Now that you have an ODFL4me account, a Developer Portal account, and an application running in the developer portal, its time to add Credentials to your organization

  • Navigate to Company Management and select your organization.
  • Find the Credential panel and click the Add (+) button.

    emptyCredential.png
    • Enter Old Dominion API for the name.
    • Choose API Key for the credential type.
    • Turn on the Production switch if you are ready to make pickup requests.
    • Set Old Dominion Freight Line (ODFL) as the carrier.
    • Enter the client's ODFL Account Number for the Account Number.
    • Click Create Credential.
    • Find the Fields panel, and click the edit button.
      fieldEditBtn.png
    • Click the Add (+) button
      Note: username and password fields will be added by default.

      addFields.png
      • in the fields on the left, you will need:
        • username
        • password
        • key
      • In the fields on the right you will need the corresponding data.
        • For username, enter your ODFL4me account username.
        • For password, enter your ODFL4me account password.
        • For key, enter your API key (this can be found on the application in the Developer Portal).
    • Click the Save button

 

 

0 Comments

Please sign in to leave a comment.