Once you have Signed Up for an account, Accepted a Plan and registered your App to generate your own API keys, you are ready to start testing our APIs. Everything you need is detailed below, starting with Step 1.  Sandbox - Empty Container Returns.  Once you are satisfied with your own development and testing, migration to production can be found in Step 2. Production -  Empty Container Returns. It's here that you will learn about our OAuth 2.0 authorisation which is needed to generate a bearer token for subsequent calls.  Finally, feel free to read our Open API spec found below via our Empty Container Retuns.yaml file.

Step 1. Sandbox - Empty Container Returns

To get you started, we've created a simple GET request API for you:  

• https://api-sandbox.apmterminals.com/empty-container-returns

To call this API, you will need to add Container numbers to the assetId query parameter, along with a Facility code, e.g. USLAX for Pier 400, Los Angeles. This API uses test data only. Go ahead and make calls using the any of the examples below;

• Test Containers = MRKU7137914, MRKU0562064, UACU8175070, CXRU1082246
• Test Facility = SEGOT

Your GET request should look something like this:

• https://api-sandbox.apmterminals.com/empty-container-returns?assetId=MRKU7137914, MRKU0562064, UACU8175070, CXRU1082246&facilityCode=SEGOT

Step 2. Production - Empty Container Returns

To access our Production APIs we have a base security policy enforcing the OAuth2.0 Client Credentials Grant. This means that you must request an access token from us which is then used in subsequent calls to the APIs. The access token is added to the "Authorization" header with a "Bearer " prefix. So, the full Authorization header looks like - "Authorization: Bearer {access_token}". This access token expires after 30 minutes, so you will need to repeat this request to get a new token.

How to request an access token?

• Issue a POST request to https://api.apmterminals.com/oauth/client_credential/accesstoken?grant_type=client_credentials
• Please ensure your POST body is x-www-form-urlencoded and includes the two following key:value pairs created when you register your App
  • client_id = your Consumer Key
  • client_secret = your Consumer Secret
• In the response you will see a key called "access_token", this is what you will include in the Authorization header for the Import Availability API

How to access the Production Empty Container Returns API?

As with our Sandbox API you can issue a simple GET request, to the endpoint listed below, but this time you will need to add your access token.

• https://api.apmterminals.com/empty-container-returns?assetId=&facilityCode=
• Headers: Authorization: Bearer Token {access_token}

The production API is connected directly to our terminal operating systems for real-time data. As such, when calling this API, you will need current container IDs, along with the appropriate facility code, e.g. USLAX for Pier 400, Los Angeles. Terminal codes shown between ():

• Aarhus, Denmark (DKAAR)
• Apapa, Nigeria (NGAPP)
• Aqaba, Jordan (JOAQB)
• Bahrain (BHKBS)
• Barcelona, Spain (ESBCN)
• Buenos Aires, Argentina (ARBUE)
• Gothenburg, Sweden (SEGOT)
• Lázaro Cárdenas, Mexico (MXLZC)
• Los Angeles, USA (USLAX)
• South Florida Container Terminal, Miami, USA (USMIA)
• Monrovia, Liberia (LRMLW)
• Mobile, USA (USMOB)
• Moin, Costa Rica (CRPMN)
• Mumbai, India (INNSA)
• Onne, Nigeria (NGONN)
• Pecém, Brazil (BRPEC)
• Pipavav, India (INPAV)
• Port Elizabeth, USA (USNWK)
• Puerto Quetzal, Guatemala (GTPRQ)
• Vado, Italy (ITVDL)

Technical Implementation 

To assist you with your implementation, please contact us to arrange appointments for the steps below. This will enable us to coordinate our efforts to set up the various systems required for a smooth implementation process.

Step 1: Introductory meeting (30 mins)

During this meeting a member of our technical team and our commercial team will:

• Introduce you to your point of contact for any questions
• Provide an outline of the onboarding process
• Establish which systems you’re already familiar with
• Gather some initial details from you, so that we can set up any necessary accounts prior to the Technical Onboarding.

Step 2: Technical onboarding meeting (Maximum of 2 hours)

During this onboarding session, which will be carried out using shared screens, we will assist you to:

• Sign up for an account and register your App
• Access your API key in our API Store
• Call the authorization API endpoint with your key to get your token
• Set up and access your TERMPoint account for your Customer Token
• Familiarize yourself with what’s possible via the API

Step 3: Your time to test

• Let us know when you plan to start testing and we'll ensure our test environment is ready and provide you with a test plan and test data.

Step 4: Switch to our live production data endpoint

Our test environment will help you see the potential for integrating the Truck Appointment API into your own systems. When you’re ready to switch to our live production data endpoint we will:

• Make sure someone is on hand to carry out some final checks with you using live data
• Test we’re receiving data as expected prior to the switch
• Let the terminal know that you’re switching to live data so that they can support you with additional service during the transition
• Provide you with a one page guide to explain to your end-users how to set up a TERMPoint account, and  use their individual TERMPoint key when using the API.

Documentation

• Guidelines for implementing our Truck Appointment System API:  Technical Documentation (pdf). 
• yaml file (see below)