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?

Based on the booking reference number, the following information will be available (some may be terminal specific):

Booking level detail:

  • Booking Reference number/ID
  • Shipping Line: Name of the shipper or container operator.
  • Vessel Name:  Name of vessel that the container will be departing on.
  • Vessel Estimated Time of Departure (ETD): Estimated date and local time that the vessel will leave terminal.
  • Begin Receiving: First possible date and time for gating-in a container at the terminal.
  • Cargo cutoff: Last possible date and time for gating-in a container at the terminal.
  • Received: Total number of containers on the booking received so far.
  • Pre-advised: Total number of Pre-advised containers.
  • Empties Out: Number of containers that were gated out empty in relation for the booking.
  • Booking Holds: Identifies freight or customs holds.
  • Size/Type/Height: Container dimensions.
  • Quantity: Total number of containers on the booking.
  • ISO Code: ISO code of the container/s.
  • VGM: Number of containers with Gross weight in kilos or pounds submitted.
  • Hazardous: Hazardous class for the shipment (if applicable).

Container level detail:

  • Booking Reference number/ID
  • Received: Yes or no whether container has been received.
  • Pre-advised: Yes or no whether container has been Pre-advised.
  • Gate in date: Date a container was received at the terminal through the gate.
  • Ready for Load: Yes or no.
  • Empty out: Yes or no whether the empty container is gated out or not.
  • Container Holds: Identifies freight or customs holds.
  • VGM: Yes or no whether Gross weight in kilos or pounds submitted for the container.
  • Size/Type/Height: Container dimensions.
  • Hazardous: Hazardous class for the container (if applicable).

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

 

Step 1. Sandbox - Export Booking Enquiry

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

  • https://api-sandbox.apmterminals.com/booking-enquiry

To call this API, you will need to add Booking reference numbers to the assetId query parameter, along with a Facility code, e.g. CRPMN for Moin, Costa Rica. This API uses test data only. Go ahead and make calls using the any of the examples below;

  • Test Booking reference numbers = 205327590, CTR0201633
  • Test Facility = CRPMN

Your GET request should look something like this:

  • https://api-sandbox.apmterminals.com/booking-enquiry?facilityCode=CRPMN&assetId=205327590,CTR0201633

Step 2. Production - Export Booking Enquiry

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 Export Booking Enquiry 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/booking-enquiry
  • 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 ():

  • 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 Export Booking Enquiry_1.yaml 13.66 KB