Benefit of using APIs

Our APIs connect directly to our terminal operating system, so you'll always benefit from real-time data. We'll maintain and manage our APIs, so once you've set them up, you can be confident that you'll continue to reap the benefits, including:

  • Increased accuracy - container data is transferred automatically removing the chance of human error or reliance on outdated information
  • Time saving & cost effective - enables large volumes of data to be handled with no manual intervention
  • Improved planning - guarantees you’re using the most up-to-date information available in the supply chain

 

What data will I have access to?

Plan your transport to and from the terminal as efficiently as possible, avoid storage charges and keep your customers updated with reliable vessel data. Based on either the vessel name or vessel lloyds code, the following information is available:

  • Inbound/Outbound Voyage Number

  • Scheduled Arrival/Departure: Date and local time when the vessel was initially scheduled to arrive at/depart from the terminal.

  • Latest Arrival/Departure Time: Updated date and local time that the vessel is scheduled to arrive at/depart from the terminal.

  • Actual Arrival/Departure Time: Actual date and local time that the vessel arrived at/departed from at the terminal.

  • Cargo Cut-Off: Latest date and local time that cargo will be accepted for the vessel/voyage.

  • Reefer Cut-Off: Latest date and local time that reefer cargo will be accepted for the vessel/voyage.

  • Berth Name: The physical Berth where the ship is docked.

  • Shipping Lines: List of all shipping lines on the vessel.

  • Vessel Status: The current vessel status known by the terminal.
     

 

For which terminals is data available?

Data is available for the following terminals and will become available for the majority of our terminals during 2020. Register for updates and we'll let you know as soon as data is available for the terminal(s) you're interested in. Terminal codes shown between ().

  • Apapa, Nigeria (NGAPP)
  • Gothenburg, Sweden (SEGOT)
  • Los Angeles, USA (USLAX)
  • Mobile, USA (USMOB)
  • Moin, Costa Rica (CRPMN)
  • Port Elizabeth, USA (USNWK)
  • Vado, Italy (ITVDL)
  • Bahrain (BHKBS)
  • Buenos Aires, Argentina (ARBUE)

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 - Vessel Schedule.  Once you are satisfied with your own development and testing, migration to production can be found in Step 2. Production -  Vessel Schedule. 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 Vessel Schedule.yaml file.

 

Step 1. Sandbox - Vessel Schedule

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

  • https://api-sandbox.apmterminals.com/vessel-visits

To call this API, you will need to add a Vessel Name to the assetId query parameters, along with a Facility code, e.g. USLAX for Pier 400, Los Angeles. Additionally, there are optional parameters to add either an Inbound or Outbound Voyage Number. This API uses test data only. Go ahead and make calls using the any of the examples below noting that you can only search for one vessel at a time.

  • Test Vessels= COSCO PIRAEUSHYUNDAI COURAGE, HYUNDAI BRAVE, MAERSK EDIRNE, MAERSK NORTHAMPTON
  • Test Facility = USLAX

Your GET request should look something like this:

  • https://api-sandbox.apmterminals.com/vessel-visits?assetId=MAERSK NORTHAMPTON&facilityCode=USLAX

 

Step 2. Production - Vessel Schedule

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 Vessel Schedule 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/vessel-visits
  • 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 vessel names, along with the appropriate facility code, e.g. USLAX for Pier 400, Los Angeles. Terminal codes shown between ():

  • Apapa, Nigeria (NGAPP)
  • Gothenburg, Sweden (SEGOT)
  • Los Angeles, USA (USLAX)
  • Mobile, USA (USMOB)
  • Moin, Costa Rica (CRPMN)
  • Port Elizabeth, USA (USNWK)
  • Vado, Italy (ITVDL)
  • Bahrain (BHKBS)
  • Buenos Aires, Argentina (ARBUE)
Attachment Size
APMT Vessel Schedule_2.yaml 8.3 KB